@itwin/core-backend 5.0.0-dev.117 → 5.0.0-dev.119

package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts

@@ -31,14 +31,14 @@ export declare class RpcBriefcaseUtility {
         syncMode: SyncMode.FixedVersion;
     }): Promise<IModelDb>;
     /**
-     * @deprecated in 4.4.0 - only `SyncMode.FixedVersion` should be used in RPC backends
+     * @deprecated in 4.4.0 - will not be removed until after 2026-06-13. Only `SyncMode.FixedVersion` should be used in RPC backends
      */
     static open(args: DownloadAndOpenArgs & {
         syncMode: Exclude<SyncMode, "FixedVersion">;
     }): Promise<IModelDb>;
     static openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode.FixedVersion, timeout?: number): Promise<IModelConnectionProps>;
     /**
-     * @deprecated in 4.4.0 - only `SyncMode.FixedVersion` should be used in RPC backends
+     * @deprecated in 4.4.0 - will not be removed until after 2026-06-13. Only `SyncMode.FixedVersion` should be used in RPC backends
      */
     static openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: Exclude<SyncMode, "FixedVersion">, timeout?: number): Promise<IModelConnectionProps>;
 }

package/lib/cjs/rpc-impl/RpcBriefcaseUtility.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcBriefcaseUtility.js","sourceRoot":"","sources":["../../../src/rpc-impl/RpcBriefcaseUtility.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4F;AAC5F,oDAE4B;AAC5B,oEAAiE;AACjE,0DAA+E;AAC/E,4DAAyD;AACzD,0CAAgE;AAChE,8CAA2C;AAC3C,8CAA2C;AAC3C,iDAAiD;AAEjD,MAAM,cAAc,GAAW,6CAAqB,CAAC,QAAQ,CAAC;AAW9D;;;GAGG;AACH,MAAa,mBAAmB;IAEtB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAyB;QAC5D,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;QACzC,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1C,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,IAAI,cAAwB,CAAC;QAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,EAAE,CAAC;YACxC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,+BAA+B;QACvD,CAAC;aAAM,CAAC;YACN,4EAA4E;YAC5E,cAAc,GAAG,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mCAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAEzF,gFAAgF;QAChF,IAAI,SAAS,EAAE,CAAC;YACd,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE,CAAC;oBACzC,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;oBACrD,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACpC,MAAM,WAAW,GAAG,sBAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;wBACzD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;4BAC9B,IAAI,WAAW,CAAC,aAAa,EAAE,EAAE,CAAC;gCAChC,OAAO,WAAW,CAAC;4BACrB,CAAC;iCAAM,CAAC;gCACN,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,wCAAwC,CAAC,CAAC;4BAC5F,CAAC;wBACH,CAAC;wBACD,IAAI,CAAC;4BACH,IAAI,IAAI,CAAC,aAAa;gCACpB,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,sBAAsB;4BAC3C,MAAM,EAAE,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;4BAChD,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,UAAU,CAAC,SAAS,EAAE,EAAE,EAAE,CAAC;gCACjD,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC;gCAC3C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,EAAE,KAAK;oCACzC,CAAC,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gCACzJ,MAAM,mCAAgB,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;4BAC9E,CAAC;4BACD,OAAO,EAAE,CAAC;wBACZ,CAAC;wBAAC,OAAO,KAAU,EAAE,CAAC;4BACpB,IAAI,CAAC,CAAC,KAAK,CAAC,WAAW,KAAK,2BAAY,CAAC,WAAW,CAAC;gCACnD,yFAAyF;gCACzF,MAAM,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;wBACvE,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,0DAA0D;QAC1D,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,OAAO,GAA2B;YACtC,WAAW;YACX,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,QAAQ;YACR,WAAW,EAAE,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,wDAAwD;SAC3H,CAAC;QAEF,MAAM,KAAK,GAAG,MAAM,mCAAgB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAChE,OAAO,sBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAEO,MAAM,CAAC,kBAAkB,GAAsC,IAAI,GAAG,EAAE,CAAC;IACzE,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAyB;QAC1D,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChI,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACvD,IAAI,aAAa;YACf,OAAO,aAAa,CAAC;QAEvB,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,8FAA8F;YACnJ,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;YACnD,OAAO,MAAM,gBAAgB,CAAC;QAChC,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAE,oCAAoC;QAC5E,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAwB,EAAE,MAAsB;QACjF,MAAM,QAAQ,GAAG,mBAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEhD,sJAAsJ;QACtJ,MAAM,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QACnD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAQD;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAyB;QAChD,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAChD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;QAExE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;QACrC,IAAI,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,IAAI,QAAQ,KAAK,sBAAQ,CAAC,WAAW,EAAE,CAAC;YACxE,MAAM,WAAW,GAAG,MAAM,yBAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;YAE7E,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;gBACxE,MAAM,IAAI,gCAAkB,EAAE,CAAC,CAAC,0DAA0D;YAC5F,CAAC;YACD,qFAAqF;YACrF,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS;YACtE,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAElE,MAAM,UAAU,GAAG;YACjB,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,WAAW,EAAE,QAAQ,CAAC,WAAW;SAClC,CAAC;QAEF,wBAAwB;QACxB,IAAI,EAAqB,CAAC;QAC1B,mCAAmC;QACnC,EAAE,GAAG,qBAAU,CAAC,YAAY,CAAC,qCAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACnE,IAAI,EAAE,EAAE,CAAC;YACP,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,6BAA6B,EAAE,UAAU,CAAC,CAAC;YAC3E,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,wBAAwB;QACxB,EAAE,GAAG,MAAM,qBAAU,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QACxD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,EAAE,UAAU,CAAC,CAAC;QAEnE,OAAO,EAAE,CAAC;IACZ,CAAC;IAQM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAqB,EAAE,UAA8B,EAAE,QAAkB,EAAE,UAAkB,IAAI;QACnI,IAAI,UAAU,CAAC,QAAQ;YACrB,MAAM,uBAAU,CAAC,WAAW,EAAE,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAChE,4DAA4D;QAC5D,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;;AA7JH,kDA+JC","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 RpcInterface\n */\n\nimport { AccessToken, assert, BeDuration, IModelStatus, Logger } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseProps, IModelConnectionProps, IModelError, IModelRpcOpenProps, IModelRpcProps, IModelVersion, RpcActivity, RpcPendingResponse, SyncMode,\n} from \"@itwin/core-common\";\nimport { BackendLoggerCategory } from \"../BackendLoggerCategory\";\nimport { BriefcaseManager, RequestNewBriefcaseArg } from \"../BriefcaseManager\";\nimport { CheckpointManager } from \"../CheckpointManager\";\nimport { BriefcaseDb, IModelDb, SnapshotDb } from \"../IModelDb\";\nimport { IModelHost } from \"../IModelHost\";\nimport { IModelJsFs } from \"../IModelJsFs\";\nimport { _hubAccess } from \"../internal/Symbols\";\n\nconst loggerCategory: string = BackendLoggerCategory.IModelDb;\n\n/** @internal */\nexport interface DownloadAndOpenArgs {\n  activity: RpcActivity;\n  tokenProps: IModelRpcOpenProps;\n  syncMode: SyncMode;\n  fileNameResolvers?: ((arg: BriefcaseProps) => string)[];\n  timeout?: number;\n  forceDownload?: boolean;\n}\n/**\n * Utility to open the iModel for RPC interfaces\n * @internal\n */\nexport class RpcBriefcaseUtility {\n\n  private static async downloadAndOpen(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\n    const { activity, tokenProps } = args;\n    const accessToken = activity.accessToken;\n    assert(undefined !== tokenProps.iModelId);\n\n    const iModelId = tokenProps.iModelId;\n    let myBriefcaseIds: number[];\n    if (args.syncMode === SyncMode.PullOnly) {\n      myBriefcaseIds = [0]; // PullOnly means briefcaseId 0\n    } else {\n      // check with iModelHub and see if we already have acquired any briefcaseIds\n      myBriefcaseIds = await IModelHost[_hubAccess].getMyBriefcaseIds({ accessToken, iModelId });\n    }\n\n    const resolvers = args.fileNameResolvers ?? [(arg) => BriefcaseManager.getFileName(arg)];\n\n    // see if we can open any of the briefcaseIds we already acquired from iModelHub\n    if (resolvers) {\n      for (const resolver of resolvers) {\n        for (const briefcaseId of myBriefcaseIds) {\n          const fileName = resolver({ briefcaseId, iModelId });\n          if (IModelJsFs.existsSync(fileName)) {\n            const briefcaseDb = BriefcaseDb.findByFilename(fileName);\n            if (briefcaseDb !== undefined) {\n              if (briefcaseDb.isBriefcaseDb()) {\n                return briefcaseDb;\n              } else {\n                throw new IModelError(IModelStatus.AlreadyOpen, \"iModel is already open as a SnapshotDb\");\n              }\n            }\n            try {\n              if (args.forceDownload)\n                throw new Error(); // causes delete below\n              const db = await BriefcaseDb.open({ fileName });\n              if (db.changeset.id !== tokenProps.changeset?.id) {\n                assert(undefined !== tokenProps.changeset);\n                const toIndex = tokenProps.changeset?.index ??\n                  (await IModelHost[_hubAccess].getChangesetFromVersion({ accessToken, iModelId, version: IModelVersion.asOfChangeSet(tokenProps.changeset.id) })).index;\n                await BriefcaseManager.pullAndApplyChangesets(db, { accessToken, toIndex });\n              }\n              return db;\n            } catch (error: any) {\n              if (!(error.errorNumber === IModelStatus.AlreadyOpen))\n                // somehow we have this briefcaseId and the file exists, but we can't open it. Delete it.\n                await BriefcaseManager.deleteBriefcaseFiles(fileName, accessToken);\n            }\n          }\n        }\n      }\n    }\n\n    // no local briefcase available. Download one and open it.\n    assert(undefined !== tokenProps.iTwinId);\n    const request: RequestNewBriefcaseArg = {\n      accessToken,\n      iTwinId: tokenProps.iTwinId,\n      iModelId,\n      briefcaseId: args.syncMode === SyncMode.PullOnly ? 0 : undefined, // if briefcaseId is undefined, we'll acquire a new one.\n    };\n\n    const props = await BriefcaseManager.downloadBriefcase(request);\n    return BriefcaseDb.open(props);\n  }\n\n  private static _briefcasePromises: Map<string, Promise<BriefcaseDb>> = new Map();\n  private static async openBriefcase(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\n    const key = `${args.tokenProps.iModelId}:${args.tokenProps.changeset?.id}:${args.tokenProps.changeset?.index}:${args.syncMode}`;\n    const cachedPromise = this._briefcasePromises.get(key);\n    if (cachedPromise)\n      return cachedPromise;\n\n    try {\n      const briefcasePromise = this.downloadAndOpen(args); // save the fact that we're working on downloading so if we timeout, we'll reuse this request.\n      this._briefcasePromises.set(key, briefcasePromise);\n      return await briefcasePromise;\n    } finally {\n      this._briefcasePromises.delete(key);  // the download and open is now done\n    }\n  }\n\n  /** find a previously opened iModel for RPC.\n   * @param accessToken necessary (only) for V2 checkpoints to refresh access token in daemon if it has expired. We use the accessToken of the current RPC request\n   * to refresh the daemon, even though it will be used for all authorized users.\n   * @param the IModelRpcProps to locate the opened iModel.\n   */\n  public static async findOpenIModel(accessToken: AccessToken, iModel: IModelRpcProps) {\n    const iModelDb = IModelDb.findByKey(iModel.key);\n\n    // call refreshContainer, just in case this is a V2 checkpoint whose sasToken is about to expire, or its default transaction is about to be restarted.\n    await iModelDb.refreshContainerForRpc(accessToken);\n    return iModelDb;\n  }\n\n  public static async open(args: DownloadAndOpenArgs & { syncMode: SyncMode.FixedVersion }): Promise<IModelDb>;\n  /**\n   * @deprecated in 4.4.0 - only `SyncMode.FixedVersion` should be used in RPC backends\n   */\n  // eslint-disable-next-line @typescript-eslint/unified-signatures -- these are separate to explicitly deprecate some SyncMode members.\n  public static async open(args: DownloadAndOpenArgs & { syncMode: Exclude<SyncMode, \"FixedVersion\"> }): Promise<IModelDb>;\n  /**\n   * Download and open a checkpoint or briefcase, ensuring the operation completes within a default timeout. If the time to open exceeds the timeout period,\n   * a RpcPendingResponse exception is thrown\n   */\n  public static async open(args: DownloadAndOpenArgs): Promise<IModelDb> {\n    const { activity, tokenProps, syncMode } = args;\n    Logger.logTrace(loggerCategory, \"RpcBriefcaseUtility.open\", tokenProps);\n\n    const timeout = args.timeout ?? 1000;\n    if (syncMode === SyncMode.PullOnly || syncMode === SyncMode.PullAndPush) {\n      const briefcaseDb = await BeDuration.race(timeout, this.openBriefcase(args));\n\n      if (briefcaseDb === undefined) {\n        Logger.logTrace(loggerCategory, \"Open briefcase - pending\", tokenProps);\n        throw new RpcPendingResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n      }\n      // note: usage is logged in the function BriefcaseManager.downloadNewBriefcaseAndOpen\n      return briefcaseDb;\n    }\n    if (!tokenProps.iModelId || !tokenProps.iTwinId || !tokenProps.changeset)\n      throw new IModelError(IModelStatus.BadArg, \"invalid arguments\");\n\n    const checkpoint = {\n      iModelId: tokenProps.iModelId,\n      iTwinId: tokenProps.iTwinId,\n      changeset: tokenProps.changeset,\n      accessToken: activity.accessToken,\n    };\n\n    // opening a checkpoint.\n    let db: SnapshotDb | void;\n    // first check if it's already open\n    db = SnapshotDb.tryFindByKey(CheckpointManager.getKey(checkpoint));\n    if (db) {\n      Logger.logTrace(loggerCategory, \"Checkpoint was already open\", tokenProps);\n      return db;\n    }\n\n    // now try V2 checkpoint\n    db = await SnapshotDb.openCheckpointFromRpc(checkpoint);\n    Logger.logTrace(loggerCategory, \"using V2 checkpoint\", tokenProps);\n\n    return db;\n  }\n\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode.FixedVersion, timeout?: number): Promise<IModelConnectionProps>;\n  /**\n   * @deprecated in 4.4.0 - only `SyncMode.FixedVersion` should be used in RPC backends\n   */\n  // eslint-disable-next-line @typescript-eslint/unified-signatures -- these are separate to explicitly deprecate some SyncMode members.\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: Exclude<SyncMode, \"FixedVersion\">, timeout?: number): Promise<IModelConnectionProps>;\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode, timeout: number = 1000): Promise<IModelConnectionProps> {\n    if (tokenProps.iModelId)\n      await IModelHost.tileStorage?.initialize(tokenProps.iModelId);\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return (await this.open({ activity, tokenProps, syncMode, timeout })).toJSON();\n  }\n\n}\n"]}
+{"version":3,"file":"RpcBriefcaseUtility.js","sourceRoot":"","sources":["../../../src/rpc-impl/RpcBriefcaseUtility.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA4F;AAC5F,oDAE4B;AAC5B,oEAAiE;AACjE,0DAA+E;AAC/E,4DAAyD;AACzD,0CAAgE;AAChE,8CAA2C;AAC3C,8CAA2C;AAC3C,iDAAiD;AAEjD,MAAM,cAAc,GAAW,6CAAqB,CAAC,QAAQ,CAAC;AAW9D;;;GAGG;AACH,MAAa,mBAAmB;IAEtB,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAyB;QAC5D,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACtC,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;QACzC,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1C,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrC,IAAI,cAAwB,CAAC;QAC7B,IAAI,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,EAAE,CAAC;YACxC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,+BAA+B;QACvD,CAAC;aAAM,CAAC;YACN,4EAA4E;YAC5E,cAAc,GAAG,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,iBAAiB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mCAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAEzF,gFAAgF;QAChF,IAAI,SAAS,EAAE,CAAC;YACd,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE,CAAC;oBACzC,MAAM,QAAQ,GAAG,QAAQ,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;oBACrD,IAAI,uBAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;wBACpC,MAAM,WAAW,GAAG,sBAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;wBACzD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;4BAC9B,IAAI,WAAW,CAAC,aAAa,EAAE,EAAE,CAAC;gCAChC,OAAO,WAAW,CAAC;4BACrB,CAAC;iCAAM,CAAC;gCACN,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,WAAW,EAAE,wCAAwC,CAAC,CAAC;4BAC5F,CAAC;wBACH,CAAC;wBACD,IAAI,CAAC;4BACH,IAAI,IAAI,CAAC,aAAa;gCACpB,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC,sBAAsB;4BAC3C,MAAM,EAAE,GAAG,MAAM,sBAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;4BAChD,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,UAAU,CAAC,SAAS,EAAE,EAAE,EAAE,CAAC;gCACjD,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,SAAS,CAAC,CAAC;gCAC3C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,EAAE,KAAK;oCACzC,CAAC,MAAM,uBAAU,CAAC,oBAAU,CAAC,CAAC,uBAAuB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAAa,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gCACzJ,MAAM,mCAAgB,CAAC,sBAAsB,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;4BAC9E,CAAC;4BACD,OAAO,EAAE,CAAC;wBACZ,CAAC;wBAAC,OAAO,KAAU,EAAE,CAAC;4BACpB,IAAI,CAAC,CAAC,KAAK,CAAC,WAAW,KAAK,2BAAY,CAAC,WAAW,CAAC;gCACnD,yFAAyF;gCACzF,MAAM,mCAAgB,CAAC,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;wBACvE,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,0DAA0D;QAC1D,IAAA,qBAAM,EAAC,SAAS,KAAK,UAAU,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,OAAO,GAA2B;YACtC,WAAW;YACX,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,QAAQ;YACR,WAAW,EAAE,IAAI,CAAC,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,wDAAwD;SAC3H,CAAC;QAEF,MAAM,KAAK,GAAG,MAAM,mCAAgB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAChE,OAAO,sBAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAEO,MAAM,CAAC,kBAAkB,GAAsC,IAAI,GAAG,EAAE,CAAC;IACzE,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAyB;QAC1D,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChI,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACvD,IAAI,aAAa;YACf,OAAO,aAAa,CAAC;QAEvB,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,8FAA8F;YACnJ,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;YACnD,OAAO,MAAM,gBAAgB,CAAC;QAChC,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAE,oCAAoC;QAC5E,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,WAAwB,EAAE,MAAsB;QACjF,MAAM,QAAQ,GAAG,mBAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEhD,sJAAsJ;QACtJ,MAAM,QAAQ,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QACnD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAQD;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAyB;QAChD,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;QAChD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;QAExE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;QACrC,IAAI,QAAQ,KAAK,sBAAQ,CAAC,QAAQ,IAAI,QAAQ,KAAK,sBAAQ,CAAC,WAAW,EAAE,CAAC;YACxE,MAAM,WAAW,GAAG,MAAM,yBAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;YAE7E,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,0BAA0B,EAAE,UAAU,CAAC,CAAC;gBACxE,MAAM,IAAI,gCAAkB,EAAE,CAAC,CAAC,0DAA0D;YAC5F,CAAC;YACD,qFAAqF;YACrF,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS;YACtE,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAElE,MAAM,UAAU,GAAG;YACjB,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,OAAO,EAAE,UAAU,CAAC,OAAO;YAC3B,SAAS,EAAE,UAAU,CAAC,SAAS;YAC/B,WAAW,EAAE,QAAQ,CAAC,WAAW;SAClC,CAAC;QAEF,wBAAwB;QACxB,IAAI,EAAqB,CAAC;QAC1B,mCAAmC;QACnC,EAAE,GAAG,qBAAU,CAAC,YAAY,CAAC,qCAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;QACnE,IAAI,EAAE,EAAE,CAAC;YACP,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,6BAA6B,EAAE,UAAU,CAAC,CAAC;YAC3E,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,wBAAwB;QACxB,EAAE,GAAG,MAAM,qBAAU,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC;QACxD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,qBAAqB,EAAE,UAAU,CAAC,CAAC;QAEnE,OAAO,EAAE,CAAC;IACZ,CAAC;IAQM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,QAAqB,EAAE,UAA8B,EAAE,QAAkB,EAAE,UAAkB,IAAI;QACnI,IAAI,UAAU,CAAC,QAAQ;YACrB,MAAM,uBAAU,CAAC,WAAW,EAAE,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAChE,4DAA4D;QAC5D,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACjF,CAAC;;AA7JH,kDA+JC","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 RpcInterface\n */\n\nimport { AccessToken, assert, BeDuration, IModelStatus, Logger } from \"@itwin/core-bentley\";\nimport {\n  BriefcaseProps, IModelConnectionProps, IModelError, IModelRpcOpenProps, IModelRpcProps, IModelVersion, RpcActivity, RpcPendingResponse, SyncMode,\n} from \"@itwin/core-common\";\nimport { BackendLoggerCategory } from \"../BackendLoggerCategory\";\nimport { BriefcaseManager, RequestNewBriefcaseArg } from \"../BriefcaseManager\";\nimport { CheckpointManager } from \"../CheckpointManager\";\nimport { BriefcaseDb, IModelDb, SnapshotDb } from \"../IModelDb\";\nimport { IModelHost } from \"../IModelHost\";\nimport { IModelJsFs } from \"../IModelJsFs\";\nimport { _hubAccess } from \"../internal/Symbols\";\n\nconst loggerCategory: string = BackendLoggerCategory.IModelDb;\n\n/** @internal */\nexport interface DownloadAndOpenArgs {\n  activity: RpcActivity;\n  tokenProps: IModelRpcOpenProps;\n  syncMode: SyncMode;\n  fileNameResolvers?: ((arg: BriefcaseProps) => string)[];\n  timeout?: number;\n  forceDownload?: boolean;\n}\n/**\n * Utility to open the iModel for RPC interfaces\n * @internal\n */\nexport class RpcBriefcaseUtility {\n\n  private static async downloadAndOpen(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\n    const { activity, tokenProps } = args;\n    const accessToken = activity.accessToken;\n    assert(undefined !== tokenProps.iModelId);\n\n    const iModelId = tokenProps.iModelId;\n    let myBriefcaseIds: number[];\n    if (args.syncMode === SyncMode.PullOnly) {\n      myBriefcaseIds = [0]; // PullOnly means briefcaseId 0\n    } else {\n      // check with iModelHub and see if we already have acquired any briefcaseIds\n      myBriefcaseIds = await IModelHost[_hubAccess].getMyBriefcaseIds({ accessToken, iModelId });\n    }\n\n    const resolvers = args.fileNameResolvers ?? [(arg) => BriefcaseManager.getFileName(arg)];\n\n    // see if we can open any of the briefcaseIds we already acquired from iModelHub\n    if (resolvers) {\n      for (const resolver of resolvers) {\n        for (const briefcaseId of myBriefcaseIds) {\n          const fileName = resolver({ briefcaseId, iModelId });\n          if (IModelJsFs.existsSync(fileName)) {\n            const briefcaseDb = BriefcaseDb.findByFilename(fileName);\n            if (briefcaseDb !== undefined) {\n              if (briefcaseDb.isBriefcaseDb()) {\n                return briefcaseDb;\n              } else {\n                throw new IModelError(IModelStatus.AlreadyOpen, \"iModel is already open as a SnapshotDb\");\n              }\n            }\n            try {\n              if (args.forceDownload)\n                throw new Error(); // causes delete below\n              const db = await BriefcaseDb.open({ fileName });\n              if (db.changeset.id !== tokenProps.changeset?.id) {\n                assert(undefined !== tokenProps.changeset);\n                const toIndex = tokenProps.changeset?.index ??\n                  (await IModelHost[_hubAccess].getChangesetFromVersion({ accessToken, iModelId, version: IModelVersion.asOfChangeSet(tokenProps.changeset.id) })).index;\n                await BriefcaseManager.pullAndApplyChangesets(db, { accessToken, toIndex });\n              }\n              return db;\n            } catch (error: any) {\n              if (!(error.errorNumber === IModelStatus.AlreadyOpen))\n                // somehow we have this briefcaseId and the file exists, but we can't open it. Delete it.\n                await BriefcaseManager.deleteBriefcaseFiles(fileName, accessToken);\n            }\n          }\n        }\n      }\n    }\n\n    // no local briefcase available. Download one and open it.\n    assert(undefined !== tokenProps.iTwinId);\n    const request: RequestNewBriefcaseArg = {\n      accessToken,\n      iTwinId: tokenProps.iTwinId,\n      iModelId,\n      briefcaseId: args.syncMode === SyncMode.PullOnly ? 0 : undefined, // if briefcaseId is undefined, we'll acquire a new one.\n    };\n\n    const props = await BriefcaseManager.downloadBriefcase(request);\n    return BriefcaseDb.open(props);\n  }\n\n  private static _briefcasePromises: Map<string, Promise<BriefcaseDb>> = new Map();\n  private static async openBriefcase(args: DownloadAndOpenArgs): Promise<BriefcaseDb> {\n    const key = `${args.tokenProps.iModelId}:${args.tokenProps.changeset?.id}:${args.tokenProps.changeset?.index}:${args.syncMode}`;\n    const cachedPromise = this._briefcasePromises.get(key);\n    if (cachedPromise)\n      return cachedPromise;\n\n    try {\n      const briefcasePromise = this.downloadAndOpen(args); // save the fact that we're working on downloading so if we timeout, we'll reuse this request.\n      this._briefcasePromises.set(key, briefcasePromise);\n      return await briefcasePromise;\n    } finally {\n      this._briefcasePromises.delete(key);  // the download and open is now done\n    }\n  }\n\n  /** find a previously opened iModel for RPC.\n   * @param accessToken necessary (only) for V2 checkpoints to refresh access token in daemon if it has expired. We use the accessToken of the current RPC request\n   * to refresh the daemon, even though it will be used for all authorized users.\n   * @param the IModelRpcProps to locate the opened iModel.\n   */\n  public static async findOpenIModel(accessToken: AccessToken, iModel: IModelRpcProps) {\n    const iModelDb = IModelDb.findByKey(iModel.key);\n\n    // call refreshContainer, just in case this is a V2 checkpoint whose sasToken is about to expire, or its default transaction is about to be restarted.\n    await iModelDb.refreshContainerForRpc(accessToken);\n    return iModelDb;\n  }\n\n  public static async open(args: DownloadAndOpenArgs & { syncMode: SyncMode.FixedVersion }): Promise<IModelDb>;\n  /**\n   * @deprecated in 4.4.0 - will not be removed until after 2026-06-13. Only `SyncMode.FixedVersion` should be used in RPC backends\n   */\n  // eslint-disable-next-line @typescript-eslint/unified-signatures -- these are separate to explicitly deprecate some SyncMode members.\n  public static async open(args: DownloadAndOpenArgs & { syncMode: Exclude<SyncMode, \"FixedVersion\"> }): Promise<IModelDb>;\n  /**\n   * Download and open a checkpoint or briefcase, ensuring the operation completes within a default timeout. If the time to open exceeds the timeout period,\n   * a RpcPendingResponse exception is thrown\n   */\n  public static async open(args: DownloadAndOpenArgs): Promise<IModelDb> {\n    const { activity, tokenProps, syncMode } = args;\n    Logger.logTrace(loggerCategory, \"RpcBriefcaseUtility.open\", tokenProps);\n\n    const timeout = args.timeout ?? 1000;\n    if (syncMode === SyncMode.PullOnly || syncMode === SyncMode.PullAndPush) {\n      const briefcaseDb = await BeDuration.race(timeout, this.openBriefcase(args));\n\n      if (briefcaseDb === undefined) {\n        Logger.logTrace(loggerCategory, \"Open briefcase - pending\", tokenProps);\n        throw new RpcPendingResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n      }\n      // note: usage is logged in the function BriefcaseManager.downloadNewBriefcaseAndOpen\n      return briefcaseDb;\n    }\n    if (!tokenProps.iModelId || !tokenProps.iTwinId || !tokenProps.changeset)\n      throw new IModelError(IModelStatus.BadArg, \"invalid arguments\");\n\n    const checkpoint = {\n      iModelId: tokenProps.iModelId,\n      iTwinId: tokenProps.iTwinId,\n      changeset: tokenProps.changeset,\n      accessToken: activity.accessToken,\n    };\n\n    // opening a checkpoint.\n    let db: SnapshotDb | void;\n    // first check if it's already open\n    db = SnapshotDb.tryFindByKey(CheckpointManager.getKey(checkpoint));\n    if (db) {\n      Logger.logTrace(loggerCategory, \"Checkpoint was already open\", tokenProps);\n      return db;\n    }\n\n    // now try V2 checkpoint\n    db = await SnapshotDb.openCheckpointFromRpc(checkpoint);\n    Logger.logTrace(loggerCategory, \"using V2 checkpoint\", tokenProps);\n\n    return db;\n  }\n\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode.FixedVersion, timeout?: number): Promise<IModelConnectionProps>;\n  /**\n   * @deprecated in 4.4.0 - will not be removed until after 2026-06-13. Only `SyncMode.FixedVersion` should be used in RPC backends\n   */\n  // eslint-disable-next-line @typescript-eslint/unified-signatures -- these are separate to explicitly deprecate some SyncMode members.\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: Exclude<SyncMode, \"FixedVersion\">, timeout?: number): Promise<IModelConnectionProps>;\n  public static async openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode, timeout: number = 1000): Promise<IModelConnectionProps> {\n    if (tokenProps.iModelId)\n      await IModelHost.tileStorage?.initialize(tokenProps.iModelId);\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return (await this.open({ activity, tokenProps, syncMode, timeout })).toJSON();\n  }\n\n}\n"]}

package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.d.ts

@@ -4,7 +4,7 @@
 import { IModelConnectionProps, IModelRpcProps, RpcInterface, SnapshotIModelRpcInterface, SnapshotOpenOptions } from "@itwin/core-common";
 /** The backend implementation of SnapshotIModelRpcInterface.
  * @internal
- * @deprecated in 5.0. Check [[IpcAppFunctions]] for replacements.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Check [[IpcAppFunctions]] for replacements.
  */
 export declare class SnapshotIModelRpcImpl extends RpcInterface implements SnapshotIModelRpcInterface {
     static register(): void;

package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js

@@ -14,7 +14,7 @@ const IModelHost_1 = require("../IModelHost");
 /* eslint-disable @typescript-eslint/no-deprecated */
 /** The backend implementation of SnapshotIModelRpcInterface.
  * @internal
- * @deprecated in 5.0. Check [[IpcAppFunctions]] for replacements.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Check [[IpcAppFunctions]] for replacements.
  */
 class SnapshotIModelRpcImpl extends core_common_1.RpcInterface {
     static register() { core_common_1.RpcManager.registerImpl(core_common_1.SnapshotIModelRpcInterface, SnapshotIModelRpcImpl); }

package/lib/cjs/rpc-impl/SnapshotIModelRpcImpl.js.map

@@ -1 +1 @@
-{"version":3,"file":"SnapshotIModelRpcImpl.js","sourceRoot":"","sources":["../../../src/rpc-impl/SnapshotIModelRpcImpl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAE4B;AAC5B,0CAAyC;AACzC,8CAA2C;AAE3C,qDAAqD;AAErD;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,0BAAY;IAC9C,MAAM,CAAC,QAAQ,KAAK,wBAAU,CAAC,YAAY,CAAC,wCAA0B,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAExG,kGAAkG;IAC3F,KAAK,CAAC,QAAQ,CAAC,QAAgB,EAAE,IAA0B;QAChE,IAAI,gBAAgB,GAAuB,QAAQ,CAAC;QACpD,IAAI,uBAAU,CAAC,wBAAwB,EAAE,CAAC;YACxC,gBAAgB,GAAG,uBAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YACpF,IAAI,SAAS,KAAK,gBAAgB;gBAChC,MAAM,IAAI,oCAAsB,EAAE,CAAC,CAAC,0DAA0D;QAClG,CAAC;QACD,OAAO,qBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC1E,CAAC;IAED,4FAA4F;IACrF,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,IAA0B;QACjE,MAAM,gBAAgB,GAAG,uBAAU,CAAC,wBAAwB,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,gBAAgB;YAChC,MAAM,IAAI,oCAAsB,EAAE,CAAC,CAAC,0DAA0D;QAEhG,OAAO,qBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC/F,CAAC;IAED,kDAAkD;IAC3C,KAAK,CAAC,KAAK,CAAC,UAA0B;QAC3C,qBAAU,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5BD,sDA4BC","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 RpcInterface\n */\n\nimport {\n  IModelConnectionProps, IModelNotFoundResponse, IModelRpcProps, RpcInterface, RpcManager, SnapshotIModelRpcInterface, SnapshotOpenOptions,\n} from \"@itwin/core-common\";\nimport { SnapshotDb } from \"../IModelDb\";\nimport { IModelHost } from \"../IModelHost\";\n\n/* eslint-disable @typescript-eslint/no-deprecated */\n\n/** The backend implementation of SnapshotIModelRpcInterface.\n * @internal\n * @deprecated in 5.0. Check [[IpcAppFunctions]] for replacements.\n */\nexport class SnapshotIModelRpcImpl extends RpcInterface implements SnapshotIModelRpcInterface {\n  public static register() { RpcManager.registerImpl(SnapshotIModelRpcInterface, SnapshotIModelRpcImpl); }\n\n  /** Ask the backend to open a snapshot iModel from a file name that is resolved by the backend. */\n  public async openFile(filePath: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\n    let resolvedFileName: string | undefined = filePath;\n    if (IModelHost.snapshotFileNameResolver) {\n      resolvedFileName = IModelHost.snapshotFileNameResolver.tryResolveFileName(filePath);\n      if (undefined === resolvedFileName)\n        throw new IModelNotFoundResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n    }\n    return SnapshotDb.openFile(resolvedFileName, opts).getConnectionProps();\n  }\n\n  /** Ask the backend to open a snapshot iModel from a key that is resolved by the backend. */\n  public async openRemote(fileKey: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\n    const resolvedFileName = IModelHost.snapshotFileNameResolver?.resolveKey(fileKey);\n    if (undefined === resolvedFileName)\n      throw new IModelNotFoundResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n\n    return SnapshotDb.openFile(resolvedFileName, { key: fileKey, ...opts }).getConnectionProps();\n  }\n\n  /** Ask the backend to close a snapshot iModel. */\n  public async close(tokenProps: IModelRpcProps): Promise<boolean> {\n    SnapshotDb.findByKey(tokenProps.key).close();\n    return true;\n  }\n}\n"]}
+{"version":3,"file":"SnapshotIModelRpcImpl.js","sourceRoot":"","sources":["../../../src/rpc-impl/SnapshotIModelRpcImpl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAE4B;AAC5B,0CAAyC;AACzC,8CAA2C;AAE3C,qDAAqD;AAErD;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,0BAAY;IAC9C,MAAM,CAAC,QAAQ,KAAK,wBAAU,CAAC,YAAY,CAAC,wCAA0B,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAExG,kGAAkG;IAC3F,KAAK,CAAC,QAAQ,CAAC,QAAgB,EAAE,IAA0B;QAChE,IAAI,gBAAgB,GAAuB,QAAQ,CAAC;QACpD,IAAI,uBAAU,CAAC,wBAAwB,EAAE,CAAC;YACxC,gBAAgB,GAAG,uBAAU,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YACpF,IAAI,SAAS,KAAK,gBAAgB;gBAChC,MAAM,IAAI,oCAAsB,EAAE,CAAC,CAAC,0DAA0D;QAClG,CAAC;QACD,OAAO,qBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC1E,CAAC;IAED,4FAA4F;IACrF,KAAK,CAAC,UAAU,CAAC,OAAe,EAAE,IAA0B;QACjE,MAAM,gBAAgB,GAAG,uBAAU,CAAC,wBAAwB,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,gBAAgB;YAChC,MAAM,IAAI,oCAAsB,EAAE,CAAC,CAAC,0DAA0D;QAEhG,OAAO,qBAAU,CAAC,QAAQ,CAAC,gBAAgB,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC/F,CAAC;IAED,kDAAkD;IAC3C,KAAK,CAAC,KAAK,CAAC,UAA0B;QAC3C,qBAAU,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5BD,sDA4BC","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 RpcInterface\n */\n\nimport {\n  IModelConnectionProps, IModelNotFoundResponse, IModelRpcProps, RpcInterface, RpcManager, SnapshotIModelRpcInterface, SnapshotOpenOptions,\n} from \"@itwin/core-common\";\nimport { SnapshotDb } from \"../IModelDb\";\nimport { IModelHost } from \"../IModelHost\";\n\n/* eslint-disable @typescript-eslint/no-deprecated */\n\n/** The backend implementation of SnapshotIModelRpcInterface.\n * @internal\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Check [[IpcAppFunctions]] for replacements.\n */\nexport class SnapshotIModelRpcImpl extends RpcInterface implements SnapshotIModelRpcInterface {\n  public static register() { RpcManager.registerImpl(SnapshotIModelRpcInterface, SnapshotIModelRpcImpl); }\n\n  /** Ask the backend to open a snapshot iModel from a file name that is resolved by the backend. */\n  public async openFile(filePath: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\n    let resolvedFileName: string | undefined = filePath;\n    if (IModelHost.snapshotFileNameResolver) {\n      resolvedFileName = IModelHost.snapshotFileNameResolver.tryResolveFileName(filePath);\n      if (undefined === resolvedFileName)\n        throw new IModelNotFoundResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n    }\n    return SnapshotDb.openFile(resolvedFileName, opts).getConnectionProps();\n  }\n\n  /** Ask the backend to open a snapshot iModel from a key that is resolved by the backend. */\n  public async openRemote(fileKey: string, opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> {\n    const resolvedFileName = IModelHost.snapshotFileNameResolver?.resolveKey(fileKey);\n    if (undefined === resolvedFileName)\n      throw new IModelNotFoundResponse(); // eslint-disable-line @typescript-eslint/only-throw-error\n\n    return SnapshotDb.openFile(resolvedFileName, { key: fileKey, ...opts }).getConnectionProps();\n  }\n\n  /** Ask the backend to close a snapshot iModel. */\n  public async close(tokenProps: IModelRpcProps): Promise<boolean> {\n    SnapshotDb.findByKey(tokenProps.key).close();\n    return true;\n  }\n}\n"]}

package/lib/esm/BackendHubAccess.d.ts

@@ -20,7 +20,7 @@ export declare class LockConflict extends IModelError {
     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)
+ * @deprecated in 4.7 - will not be removed until after 2026-06-13. Use [LockState]($common)
  * @public
  */
 export declare enum LockState {

package/lib/esm/BackendHubAccess.js

@@ -24,7 +24,7 @@ export class LockConflict extends IModelError {
     }
 }
 /** 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)
+ * @deprecated in 4.7 - will not be removed until after 2026-06-13. Use [LockState]($common)
  * @public
  */
 export var LockState;

package/lib/esm/BackendHubAccess.js.map

@@ -1 +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, ChangesetIndexOrId, ChangesetProps, ChangesetRange,\n  LockState as CommonLockState, IModelError, IModelVersion,\n  LocalDirName, LocalFileName,\n} from \"@itwin/core-common\";\nimport { CheckpointProps, 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  /** 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"]}
+{"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, ChangesetIndexOrId, ChangesetProps, ChangesetRange,\n  LockState as CommonLockState, IModelError, IModelVersion,\n  LocalDirName, LocalFileName,\n} from \"@itwin/core-common\";\nimport { CheckpointProps, 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 - will not be removed until after 2026-06-13. 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  /** 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/Category.d.ts

@@ -7,7 +7,7 @@ import { DefinitionElement } from "./Element";
 import { IModelDb } from "./IModelDb";
 import { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from "./Entity";
 /** Defines the appearance for graphics in Geometric elements
- * @public
+ * @public @preview
  */
 export declare class SubCategory extends DefinitionElement {
     static get className(): string;
@@ -69,7 +69,7 @@ export declare class SubCategory extends DefinitionElement {
     static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
 }
 /** A Category element is the target of the `category` member of [[GeometricElement]].
- * @public
+ * @public @preview
  */
 export declare class Category extends DefinitionElement {
     static get className(): string;
@@ -101,7 +101,7 @@ export declare class Category extends DefinitionElement {
     setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void;
 }
 /** Categorizes 2d GeometricElements.
- * @public
+ * @public @preview
  */
 export declare class DrawingCategory extends Category {
     static get className(): string;
@@ -136,7 +136,7 @@ export declare class DrawingCategory extends Category {
     static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String;
 }
 /** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).
- * @public
+ * @public @preview
  */
 export declare class SpatialCategory extends Category {
     static get className(): string;

package/lib/esm/Category.js

@@ -11,7 +11,7 @@ import { DefinitionElement } from "./Element";
 import { IModelDb } from "./IModelDb";
 import { CategoryOwnsSubCategories } from "./NavigationRelationship";
 /** Defines the appearance for graphics in Geometric elements
- * @public
+ * @public @preview
  */
 export class SubCategory extends DefinitionElement {
     static get className() { return "SubCategory"; }
@@ -123,7 +123,7 @@ export class SubCategory extends DefinitionElement {
     }
 }
 /** A Category element is the target of the `category` member of [[GeometricElement]].
- * @public
+ * @public @preview
  */
 export class Category extends DefinitionElement {
     static get className() { return "Category"; }
@@ -186,7 +186,7 @@ export class Category extends DefinitionElement {
     }
 }
 /** Categorizes 2d GeometricElements.
- * @public
+ * @public @preview
  */
 export class DrawingCategory extends Category {
     static get className() { return "DrawingCategory"; }
@@ -241,7 +241,7 @@ export class DrawingCategory extends Category {
     }
 }
 /** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).
- * @public
+ * @public @preview
  */
 export class SpatialCategory extends Category {
     static get className() { return "SpatialCategory"; }

package/lib/esm/Category.js.map

@@ -1 +1 @@
-{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACL,WAAW,EAAiB,IAAI,EAA0C,IAAI,EAAE,qBAAqB,GACtG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAGrE;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,iBAAiB;IACzC,MAAM,KAAc,SAAS,KAAa,OAAO,aAAa,CAAC,CAAC,CAAC;IACxE,qDAAqD;IAC9C,UAAU,CAAwB;IACzC,gDAAgD;IACzC,WAAW,CAAU;IAE5B,YAAsB,KAAuB,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,IAAI,qBAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;QAChD,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE;KAChD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAqB,CAAC;QAC7D,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;YAChC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAgC,CAAC;QACvF,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;QACjC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAuB,EAAE,MAAgB;QACxE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAsB,CAAC;QAC/C,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,mDAAmD;IAC5C,kBAAkB,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,qCAAqC;IAC9B,gBAAgB,KAAiB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACzD,wDAAwD;IACjD,aAAa,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1F,uEAAuE;IACvE,IAAW,oBAAoB,KAAc,OAAO,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IAEzI;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,gBAAgC,EAAE,SAAiB;QAC5F,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAC/E,OAAO,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,IAAI,UAAU,YAAY,qBAAqB;YAC7C,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAEnC,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAW,gBAAgB,CAAC,CAAC;QAChF,MAAM,gBAAgB,GAAqB;YACzC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,MAAM,EAAE,IAAI,yBAAyB,CAAC,gBAAgB,CAAC;YACvD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,CAAC;YACvD,UAAU;SACX,CAAC;QACF,OAAO,IAAI,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAC9E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/D,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,iBAAiB;IACtC,MAAM,KAAc,SAAS,KAAa,OAAO,UAAU,CAAC,CAAC,CAAC;IAC9D,IAAI,GAAS,IAAI,CAAC,IAAI,CAAC;IACvB,WAAW,CAAU;IAE5B,YAAsB,KAAoB,EAAE,MAAgB;QAC1D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;QACzC,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;KACjD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAkB,CAAC;QAC1D,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAoB,EAAE,MAAgB;QACrE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,SAAS,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IACe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAmB,CAAC;QAC5C,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,+DAA+D;IACxD,sBAAsB,KAAiB,OAAO,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEjG,sEAAsE;IAC/D,oBAAoB,CAAC,KAA0D;QACpF,IAAI,KAAK,YAAY,qBAAqB;YACxC,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAc,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAC3F,MAAM,CAAC,UAAU,GAAG,IAAI,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAE5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACjE,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,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 iModels\n */\n\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, CategoryProps, Code, CodeScopeProps, CodeSpec, ElementProps, Rank, SubCategoryAppearance, SubCategoryProps,\n} from \"@itwin/core-common\";\nimport { DefinitionElement } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { CategoryOwnsSubCategories } from \"./NavigationRelationship\";\nimport { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\n\n/** Defines the appearance for graphics in Geometric elements\n * @public\n */\nexport class SubCategory extends DefinitionElement {\n  public static override get className(): string { return \"SubCategory\"; }\n  /** The Appearance parameters for this SubCategory */\n  public appearance: SubCategoryAppearance;\n  /** Optional description of this SubCategory. */\n  public description?: string;\n\n  protected constructor(props: SubCategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.appearance = new SubCategoryAppearance(props.appearance);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  /**\n   * SubCategory custom HandledProps include 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"description\", source: \"Class\" },\n    { propertyName: \"properties\", source: \"Class\" },\n  ];\n\n  /**\n   * SubCategory deserializes 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): SubCategoryProps {\n    const elProps = super.deserialize(props) as SubCategoryProps;\n    elProps.description = JsonUtils.asString(props.row.description);\n    if (props.row.properties !== '') {\n      elProps.appearance = JSON.parse(props.row.properties) as SubCategoryAppearance.Props;\n    } else {\n      elProps.appearance = undefined;\n    }\n    return elProps;\n  }\n\n  /**\n   * SubCategory serialize 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: SubCategoryProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    if (props.description !== undefined) {\n      inst.description = props.description;\n    }\n    if (props.appearance !== undefined) {\n      inst.properties = JSON.stringify(props.appearance);\n    }\n    return inst;\n  }\n\n  public override toJSON(): SubCategoryProps {\n    const val = super.toJSON() as SubCategoryProps;\n    val.appearance = this.appearance.toJSON();\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the SubCategory's name (its Code value). */\n  public getSubCategoryName(): string { return this.code.value; }\n  /** Get the Id of the SubCategory. */\n  public getSubCategoryId(): Id64String { return this.id; }\n  /** Get the Id of this SubCategory's parent Category. */\n  public getCategoryId(): Id64String { return this.parent ? this.parent.id : Id64.invalid; }\n  /** Check if this is the default SubCategory of its parent Category. */\n  public get isDefaultSubCategory(): boolean { return IModelDb.getDefaultSubCategoryId(this.getCategoryId()) === this.getSubCategoryId(); }\n\n  /** Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.\n   * @param iModel  The IModel\n   * @param parentCategoryId The Id of the parent Category that owns the SubCategory and provides the scope for its name.\n   * @param codeValue The name of the SubCategory\n   */\n  public static createCode(iModel: IModelDb, parentCategoryId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.subCategory);\n    return new Code({ spec: codeSpec.id, scope: parentCategoryId, value: codeValue });\n  }\n\n  /** Create a new SubCategory\n   * @param iModelDb The iModel\n   * @param parentCategoryId Create the new SubCategory as a child of this [[Category]]\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The newly constructed SubCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): SubCategory {\n    if (appearance instanceof SubCategoryAppearance)\n      appearance = appearance.toJSON();\n\n    const parentCategory = iModelDb.elements.getElement<Category>(parentCategoryId);\n    const subCategoryProps: SubCategoryProps = {\n      classFullName: this.classFullName,\n      model: parentCategory.model,\n      parent: new CategoryOwnsSubCategories(parentCategoryId),\n      code: this.createCode(iModelDb, parentCategoryId, name),\n      appearance,\n    };\n    return new SubCategory(subCategoryProps, iModelDb);\n  }\n\n  /** Insert a new SubCategory\n   * @param iModelDb Insert into this iModel\n   * @param parentCategoryId Insert the new SubCategory as a child of this Category\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The Id of the newly inserted SubCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const subCategory = this.create(iModelDb, parentCategoryId, name, appearance);\n    return iModelDb.elements.insertElement(subCategory.toJSON());\n  }\n}\n\n/** A Category element is the target of the `category` member of [[GeometricElement]].\n * @public\n */\nexport class Category extends DefinitionElement {\n  public static override get className(): string { return \"Category\"; }\n  public rank: Rank = Rank.User;\n  public description?: string;\n\n  protected constructor(props: CategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.rank = JsonUtils.asInt(props.rank);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  /**\n   * Category custom HandledProps include 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"rank\", source: \"Class\" },\n    { propertyName: \"description\", source: \"Class\" },\n  ];\n\n  /**\n   * Category deserializes 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): CategoryProps {\n    const elProps = super.deserialize(props) as CategoryProps;\n    elProps.description = JsonUtils.asString(props.row.description);\n    elProps.rank = JsonUtils.asInt(props.row.rank);\n    return elProps;\n  }\n\n  /**\n   * Category serialize 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: CategoryProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    if (undefined !== props.description) {\n      inst.description = props.description;\n    }\n    inst.rank = props.rank;\n    return inst;\n  }\n  public override toJSON(): CategoryProps {\n    const val = super.toJSON() as CategoryProps;\n    val.rank = this.rank;\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the Id of the default SubCategory for this Category. */\n  public myDefaultSubCategoryId(): Id64String { return IModelDb.getDefaultSubCategoryId(this.id); }\n\n  /** Set the appearance of the default SubCategory for this Category */\n  public setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void {\n    if (props instanceof SubCategoryAppearance)\n      props = props.toJSON();\n\n    const subCat = this.iModel.elements.getElement<SubCategory>(this.myDefaultSubCategoryId());\n    subCat.appearance = new SubCategoryAppearance(props);\n    this.iModel.elements.updateElement(subCat.toJSON());\n  }\n}\n\n/** Categorizes 2d GeometricElements.\n * @public\n */\nexport class DrawingCategory extends Category {\n  public static override get className(): string { return \"DrawingCategory\"; }\n\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by DrawingCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.drawingCategory; }\n\n  /** Looks up the CategoryId of a DrawingCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = DrawingCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a DrawingCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the DrawingCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A drawing category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(DrawingCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new DrawingCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @returns The newly constructed DrawingCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DrawingCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new DrawingCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new DrawingCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DrawingCategory into this [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this DrawingCategory\n   * @returns The Id of the newly inserted DrawingCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    const elements = iModelDb.elements;\n    category.id = elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n\n/** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).\n * @public\n */\nexport class SpatialCategory extends Category {\n  public static override get className(): string { return \"SpatialCategory\"; }\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by SpatialCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.spatialCategory; }\n\n  /** Looks up the CategoryId of a SpatialCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = SpatialCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the SpatialCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A spatial category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(SpatialCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new SpatialCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the SpatialCategory\n   * @returns The newly constructed SpatialCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): SpatialCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new SpatialCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new SpatialCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new SpatialCategory into this DefinitionModel\n   * @param name The name of the SpatialCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this SpatialCategory\n   * @returns The Id of the newly inserted SpatialCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    category.id = iModelDb.elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n"]}
+{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../src/Category.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAc,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EACL,WAAW,EAAiB,IAAI,EAA0C,IAAI,EAAE,qBAAqB,GACtG,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAGrE;;GAEG;AACH,MAAM,OAAO,WAAY,SAAQ,iBAAiB;IACzC,MAAM,KAAc,SAAS,KAAa,OAAO,aAAa,CAAC,CAAC,CAAC;IACxE,qDAAqD;IAC9C,UAAU,CAAwB;IACzC,gDAAgD;IACzC,WAAW,CAAU;IAE5B,YAAsB,KAAuB,EAAE,MAAgB;QAC7D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,IAAI,qBAAqB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;QAChD,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE;KAChD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAqB,CAAC;QAC7D,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;YAChC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAgC,CAAC;QACvF,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;QACjC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAuB,EAAE,MAAgB;QACxE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,KAAK,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YACnC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAsB,CAAC;QAC/C,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAC1C,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,mDAAmD;IAC5C,kBAAkB,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,qCAAqC;IAC9B,gBAAgB,KAAiB,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACzD,wDAAwD;IACjD,aAAa,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1F,uEAAuE;IACvE,IAAW,oBAAoB,KAAc,OAAO,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IAEzI;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,gBAAgC,EAAE,SAAiB;QAC5F,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAC/E,OAAO,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,IAAI,UAAU,YAAY,qBAAqB;YAC7C,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;QAEnC,MAAM,cAAc,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAW,gBAAgB,CAAC,CAAC;QAChF,MAAM,gBAAgB,GAAqB;YACzC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,cAAc,CAAC,KAAK;YAC3B,MAAM,EAAE,IAAI,yBAAyB,CAAC,gBAAgB,CAAC;YACvD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,CAAC;YACvD,UAAU;SACX,CAAC;QACF,OAAO,IAAI,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,gBAA4B,EAAE,IAAY,EAAE,UAA+D;QAClJ,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;QAC9E,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/D,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,iBAAiB;IACtC,MAAM,KAAc,SAAS,KAAa,OAAO,UAAU,CAAC,CAAC,CAAC;IAC9D,IAAI,GAAS,IAAI,CAAC,IAAI,CAAC;IACvB,WAAW,CAAU;IAE5B,YAAsB,KAAoB,EAAE,MAAgB;QAC1D,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACO,MAAM,CAAmB,mBAAmB,GAA4B;QAChF,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;QACzC,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE;KACjD,CAAC;IAEF;;;;OAIG;IACI,MAAM,CAAU,WAAW,CAAC,KAA4B;QAC7D,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC,KAAK,CAAkB,CAAC;QAC1D,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChE,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAU,SAAS,CAAC,KAAoB,EAAE,MAAgB;QACrE,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,SAAS,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IACe,MAAM;QACpB,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,EAAmB,CAAC;QAC5C,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACjD,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC;IAED,+DAA+D;IACxD,sBAAsB,KAAiB,OAAO,QAAQ,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEjG,sEAAsE;IAC/D,oBAAoB,CAAC,KAA0D;QACpF,IAAI,KAAK,YAAY,qBAAqB;YACxC,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAc,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;QAC3F,MAAM,CAAC,UAAU,GAAG,IAAI,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACtD,CAAC;;AAGH;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAE5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACxD,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,QAAQ;IACpC,MAAM,KAAc,SAAS,KAAa,OAAO,iBAAiB,CAAC,CAAC,CAAC;IAC5E,YAAsB,IAAkB,EAAE,MAAgB,IAAI,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpF,4EAA4E;IACrE,MAAM,CAAC,eAAe,KAAa,OAAO,WAAW,CAAC,eAAe,CAAC,CAAC,CAAC;IAE/E,qEAAqE;IAC9D,MAAM,CAAC,qBAAqB,CAAC,MAAgB,EAAE,YAAwB,EAAE,YAAoB;QAClG,MAAM,IAAI,GAAS,eAAe,CAAC,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;QAClF,OAAO,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAAgB,EAAE,YAA4B,EAAE,SAAiB;QACxF,MAAM,QAAQ,GAAa,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC,CAAC;QACzF,OAAO,IAAI,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY;QAClF,MAAM,aAAa,GAAkB;YACnC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC;YACxD,SAAS,EAAE,KAAK;SACjB,CAAC;QACF,OAAO,IAAI,eAAe,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CAAC,QAAkB,EAAE,iBAA6B,EAAE,IAAY,EAAE,iBAAsE;QAC1J,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAChE,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;QACjE,QAAQ,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;QACjD,OAAO,QAAQ,CAAC,EAAE,CAAC;IACrB,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 iModels\n */\n\nimport { Id64, Id64String, JsonUtils } from \"@itwin/core-bentley\";\nimport {\n  BisCodeSpec, CategoryProps, Code, CodeScopeProps, CodeSpec, ElementProps, Rank, SubCategoryAppearance, SubCategoryProps,\n} from \"@itwin/core-common\";\nimport { DefinitionElement } from \"./Element\";\nimport { IModelDb } from \"./IModelDb\";\nimport { CategoryOwnsSubCategories } from \"./NavigationRelationship\";\nimport { CustomHandledProperty, DeserializeEntityArgs, ECSqlRow } from \"./Entity\";\n\n/** Defines the appearance for graphics in Geometric elements\n * @public @preview\n */\nexport class SubCategory extends DefinitionElement {\n  public static override get className(): string { return \"SubCategory\"; }\n  /** The Appearance parameters for this SubCategory */\n  public appearance: SubCategoryAppearance;\n  /** Optional description of this SubCategory. */\n  public description?: string;\n\n  protected constructor(props: SubCategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.appearance = new SubCategoryAppearance(props.appearance);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  /**\n   * SubCategory custom HandledProps include 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"description\", source: \"Class\" },\n    { propertyName: \"properties\", source: \"Class\" },\n  ];\n\n  /**\n   * SubCategory deserializes 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): SubCategoryProps {\n    const elProps = super.deserialize(props) as SubCategoryProps;\n    elProps.description = JsonUtils.asString(props.row.description);\n    if (props.row.properties !== '') {\n      elProps.appearance = JSON.parse(props.row.properties) as SubCategoryAppearance.Props;\n    } else {\n      elProps.appearance = undefined;\n    }\n    return elProps;\n  }\n\n  /**\n   * SubCategory serialize 'description' and 'properties'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: SubCategoryProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    if (props.description !== undefined) {\n      inst.description = props.description;\n    }\n    if (props.appearance !== undefined) {\n      inst.properties = JSON.stringify(props.appearance);\n    }\n    return inst;\n  }\n\n  public override toJSON(): SubCategoryProps {\n    const val = super.toJSON() as SubCategoryProps;\n    val.appearance = this.appearance.toJSON();\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the SubCategory's name (its Code value). */\n  public getSubCategoryName(): string { return this.code.value; }\n  /** Get the Id of the SubCategory. */\n  public getSubCategoryId(): Id64String { return this.id; }\n  /** Get the Id of this SubCategory's parent Category. */\n  public getCategoryId(): Id64String { return this.parent ? this.parent.id : Id64.invalid; }\n  /** Check if this is the default SubCategory of its parent Category. */\n  public get isDefaultSubCategory(): boolean { return IModelDb.getDefaultSubCategoryId(this.getCategoryId()) === this.getSubCategoryId(); }\n\n  /** Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.\n   * @param iModel  The IModel\n   * @param parentCategoryId The Id of the parent Category that owns the SubCategory and provides the scope for its name.\n   * @param codeValue The name of the SubCategory\n   */\n  public static createCode(iModel: IModelDb, parentCategoryId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(BisCodeSpec.subCategory);\n    return new Code({ spec: codeSpec.id, scope: parentCategoryId, value: codeValue });\n  }\n\n  /** Create a new SubCategory\n   * @param iModelDb The iModel\n   * @param parentCategoryId Create the new SubCategory as a child of this [[Category]]\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The newly constructed SubCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): SubCategory {\n    if (appearance instanceof SubCategoryAppearance)\n      appearance = appearance.toJSON();\n\n    const parentCategory = iModelDb.elements.getElement<Category>(parentCategoryId);\n    const subCategoryProps: SubCategoryProps = {\n      classFullName: this.classFullName,\n      model: parentCategory.model,\n      parent: new CategoryOwnsSubCategories(parentCategoryId),\n      code: this.createCode(iModelDb, parentCategoryId, name),\n      appearance,\n    };\n    return new SubCategory(subCategoryProps, iModelDb);\n  }\n\n  /** Insert a new SubCategory\n   * @param iModelDb Insert into this iModel\n   * @param parentCategoryId Insert the new SubCategory as a child of this Category\n   * @param name The name of the SubCategory\n   * @param appearance The appearance settings to use for this SubCategory\n   * @returns The Id of the newly inserted SubCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, parentCategoryId: Id64String, name: string, appearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const subCategory = this.create(iModelDb, parentCategoryId, name, appearance);\n    return iModelDb.elements.insertElement(subCategory.toJSON());\n  }\n}\n\n/** A Category element is the target of the `category` member of [[GeometricElement]].\n * @public @preview\n */\nexport class Category extends DefinitionElement {\n  public static override get className(): string { return \"Category\"; }\n  public rank: Rank = Rank.User;\n  public description?: string;\n\n  protected constructor(props: CategoryProps, iModel: IModelDb) {\n    super(props, iModel);\n    this.rank = JsonUtils.asInt(props.rank);\n    this.description = JsonUtils.asString(props.description);\n  }\n\n  /**\n   * Category custom HandledProps include 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  protected static override readonly _customHandledProps: CustomHandledProperty[] = [\n    { propertyName: \"rank\", source: \"Class\" },\n    { propertyName: \"description\", source: \"Class\" },\n  ];\n\n  /**\n   * Category deserializes 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override deserialize(props: DeserializeEntityArgs): CategoryProps {\n    const elProps = super.deserialize(props) as CategoryProps;\n    elProps.description = JsonUtils.asString(props.row.description);\n    elProps.rank = JsonUtils.asInt(props.row.rank);\n    return elProps;\n  }\n\n  /**\n   * Category serialize 'rank' and 'description'.\n   * @inheritdoc\n   * @beta\n   */\n  public static override serialize(props: CategoryProps, iModel: IModelDb): ECSqlRow {\n    const inst = super.serialize(props, iModel);\n    if (undefined !== props.description) {\n      inst.description = props.description;\n    }\n    inst.rank = props.rank;\n    return inst;\n  }\n  public override toJSON(): CategoryProps {\n    const val = super.toJSON() as CategoryProps;\n    val.rank = this.rank;\n    if (this.description && this.description.length > 0)\n      val.description = this.description;\n    return val;\n  }\n\n  /** Get the Id of the default SubCategory for this Category. */\n  public myDefaultSubCategoryId(): Id64String { return IModelDb.getDefaultSubCategoryId(this.id); }\n\n  /** Set the appearance of the default SubCategory for this Category */\n  public setDefaultAppearance(props: SubCategoryAppearance.Props | SubCategoryAppearance): void {\n    if (props instanceof SubCategoryAppearance)\n      props = props.toJSON();\n\n    const subCat = this.iModel.elements.getElement<SubCategory>(this.myDefaultSubCategoryId());\n    subCat.appearance = new SubCategoryAppearance(props);\n    this.iModel.elements.updateElement(subCat.toJSON());\n  }\n}\n\n/** Categorizes 2d GeometricElements.\n * @public @preview\n */\nexport class DrawingCategory extends Category {\n  public static override get className(): string { return \"DrawingCategory\"; }\n\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by DrawingCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.drawingCategory; }\n\n  /** Looks up the CategoryId of a DrawingCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = DrawingCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a DrawingCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the DrawingCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A drawing category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(DrawingCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new DrawingCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @returns The newly constructed DrawingCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DrawingCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new DrawingCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new DrawingCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new DrawingCategory into this [[DefinitionModel]]\n   * @param name The name of the DrawingCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this DrawingCategory\n   * @returns The Id of the newly inserted DrawingCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    const elements = iModelDb.elements;\n    category.id = elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n\n/** Categorizes SpatialElements. See [how to create a SpatialCategory]($docs/learning/backend/CreateElements.md#SpatialCategory).\n * @public @preview\n */\nexport class SpatialCategory extends Category {\n  public static override get className(): string { return \"SpatialCategory\"; }\n  protected constructor(opts: ElementProps, iModel: IModelDb) { super(opts, iModel); }\n\n  /** Get the name of the CodeSpec that is used by SpatialCategory objects. */\n  public static getCodeSpecName(): string { return BisCodeSpec.spatialCategory; }\n\n  /** Looks up the CategoryId of a SpatialCategory by model and name */\n  public static queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined {\n    const code: Code = SpatialCategory.createCode(iModel, scopeModelId, categoryName);\n    return iModel.elements.queryElementIdByCode(code);\n  }\n\n  /** Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.\n   * @param iModel  The IModel\n   * @param scopeModelId The Id of the DefinitionModel that contains the SpatialCategory and provides the scope for its name.\n   * @param codeValue The name of the category\n   * @return A spatial category Code\n   */\n  public static createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code {\n    const codeSpec: CodeSpec = iModel.codeSpecs.getByName(SpatialCategory.getCodeSpecName());\n    return new Code({ spec: codeSpec.id, scope: scopeModelId, value: codeValue });\n  }\n\n  /** Create a new SpatialCategory\n   * @param iModelDb The iModel\n   * @param definitionModelId The [[DefinitionModel]]\n   * @param name The name/CodeValue of the SpatialCategory\n   * @returns The newly constructed SpatialCategory element.\n   * @throws [[IModelError]] if unable to create the element.\n   */\n  public static create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): SpatialCategory {\n    const categoryProps: CategoryProps = {\n      classFullName: this.classFullName,\n      model: definitionModelId,\n      code: this.createCode(iModelDb, definitionModelId, name),\n      isPrivate: false,\n    };\n    return new SpatialCategory(categoryProps, iModelDb);\n  }\n\n  /** Insert a new SpatialCategory\n   * @param iModelDb Insert into this iModel\n   * @param definitionModelId Insert the new SpatialCategory into this DefinitionModel\n   * @param name The name of the SpatialCategory\n   * @param defaultAppearance The appearance settings to use for the default SubCategory of this SpatialCategory\n   * @returns The Id of the newly inserted SpatialCategory element.\n   * @throws [[IModelError]] if unable to insert the element.\n   */\n  public static insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: SubCategoryAppearance.Props | SubCategoryAppearance): Id64String {\n    const category = this.create(iModelDb, definitionModelId, name);\n    category.id = iModelDb.elements.insertElement(category.toJSON());\n    category.setDefaultAppearance(defaultAppearance);\n    return category.id;\n  }\n}\n"]}

package/lib/esm/ClassRegistry.d.ts

@@ -107,7 +107,7 @@ export declare class ClassRegistry {
  * A cache that records the mapping between class names and class metadata.
  * @see [[IModelDb.classMetaDataRegistry]] to access the registry for a specific iModel.
  * @internal
- * @deprecated in 5.0. Please use `schemaContext` from the `iModel` instead.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `schemaContext` from the `iModel` instead.
  *
  * @example
  * @

package/lib/esm/ClassRegistry.js

@@ -284,7 +284,7 @@ export class ClassRegistry {
  * A cache that records the mapping between class names and class metadata.
  * @see [[IModelDb.classMetaDataRegistry]] to access the registry for a specific iModel.
  * @internal
- * @deprecated in 5.0. Please use `schemaContext` from the `iModel` instead.
+ * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `schemaContext` from the `iModel` instead.
  *
  * @example
  * @

package/lib/esm/ClassRegistry.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClassRegistry.js","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAc,YAAY,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACvF,OAAO,EAAsC,WAAW,EAAkB,MAAM,oBAAoB,CAAC;AACrG,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,gBAAgB;IACV,SAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;IAE9D,gBAAgB;IACT,GAAG,CAAC,aAAqB;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,aAAqB;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,aAAqB,EAAE,WAA0B;QAC1D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,WAAW,CAAC,CAAC;IAC/D,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,aAAqB;QACjC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,gBAAgB;IACT,KAAK;QACV,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;IAED,gBAAgB;IACT,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;OAUG;IACI,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QAC/D,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,MAAM,GAAG,SAAS,GAAG,4FAA4F,WAAW,CAAC,IAAI,EAAE,CAAC;YAC1I,MAAM,CAAC,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;QACD,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IAC7B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAa;IAChB,MAAM,CAAU,eAAe,GAAG,IAAI,gBAAgB,EAAE,CAAC;IACjE,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,GAAQ,IAAI,OAAO,CAAC,GAAG,YAAY,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/H,gBAAgB;IACT,MAAM,CAAC,yBAAyB,CAAC,SAAiB,IAAiB,OAAO,IAAI,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,0BAA0B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACjK;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QACtE,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,MAAgB;QACjE,MAAM,WAAW,GAAG,MAAM,CAAC,2BAA2B,CAAC;;;;;+FAKoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,QAAQ,CAAC,aAAa,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,KAAM,SAAQ,MAAM;YAC/B,MAAM,KAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;YACnD,MAAM,KAAc,uBAAuB,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;SAC7E,CAAC;QAEF,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,0CAA0C;QACxF,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,MAAgB,EAAE,eAAuB;QACnE,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAC/E,IAAI,cAAc,CAAC,KAAK;YACtB,MAAM,IAAI,WAAW,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,8BAA8B,eAAe,GAAG,CAAC,CAAC;QAEvG,MAAM,CAAC,SAAS,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,CAAC,CAAC,WAAW,IAAI,UAAU,CAAC,IAAI,UAAU,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACvE,OAAO,eAAe,CAAC;QACzB,CAAC;QAED,2EAA2E;QAC3E,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,UAAU,CAAC,SAAS,IAAI,UAAU,CAAC,SAAmB,CAAC;QACnF,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,4DAA4D;IACpD,MAAM,CAAC,sBAAsB,CAAC,cAA8B,EAAE,MAAgB;QACpF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,qCAAqC;YAChF,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAoB,CAAC,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACzF,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iCAAiC;QAE1F,MAAM,kBAAkB,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QACvE,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAC7G,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAE3F,6GAA6G;QAC7G,sEAAsE;QACtE,IAAI,4CAA4C,GAAG,KAAK,CAAC;QACzD,IAAI,iBAAiB,GAAG,UAAU,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,EAAE,CAAC;YACnC,IAAI,iBAAiB,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;gBACnD,MAAM;YAER,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,CAAC;gBACxC,4CAA4C,GAAG,IAAI,CAAC;gBACpD,MAAM;YACR,CAAC;YACD,4DAA4D;YAC5D,MAAM,kBAAkB,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC9F,IAAI,kBAAkB,KAAK,SAAS;gBAClC,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,0CAA0C,iBAAiB,CAAC,IAAI,2CAA2C,CAAC,CAAC;YAC7J,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACrF,IAAI,mBAAmB,KAAK,SAAS;gBACnC,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,qCAAqC,iBAAiB,CAAC,IAAI,iDAAiD,CAAC,CAAC;YAC9J,iBAAiB,GAAG,mBAAmB,CAAC;QAC1C,CAAC;QAED,MAAM,cAAc,GAAG,KAAM,SAAQ,UAAU;YACtC,MAAM,KAAc,SAAS,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;YACpD,MAAM,CAAC,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC;YACrC,MAAM,KAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;SACnG,CAAC;QAEF,oIAAoI;QACpI,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAE,2DAA2D;QAErI,0EAA0E;QAC1E,sCAAsC;QACtC,yGAAyG;QACzG,IAAI,CAAC,4CAA4C,EAAE,CAAC;YAClD,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC;iBAC9D,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;gBAC7C,wDAAwD;iBACvD,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;gBACpB,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAqB,CAAC,CAAC;gBAChH,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE,mDAAmD,CAAC,CAAC;gBAChG,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBACrD,MAAM,iBAAiB,GAAG,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvG,8FAA8F;gBAC9F,2BAA2B;gBAC3B,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAC1E,MAAM,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,CAAC;gBAC3F,MAAM,CAAC,SAAS,EAAE,sBAAsB,IAAI,CAAC,iBAAiB,sBAAsB,CAAC,CAAC;gBACtF,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,gBAAgB,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;YACjF,CAAC,CAAC,CAAC;YAEL,MAAM,CAAC,cAAc,CACnB,cAAc,CAAC,SAAS,EACxB,qBAAqB,EACrB;gBACE,KAAK,CAA8B,YAAgC;oBACjE,2DAA2D;oBAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;oBAC9D,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;oBACnC,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE,CAAC;wBACtC,MAAM,WAAW,GAAgC,IAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,qDAAqD;wBAClI,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAC/C,SAAS;wBACX,MAAM,WAAW,GAAG,gBAAgB,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;wBAChG,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;oBAChC,CAAC;gBACH,CAAC;gBACD,wFAAwF;gBACxF,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,IAAI;aACnB,CACF,CAAC;QACJ,CAAC;QAED,qGAAqG;QACrG,IAAI,MAAM,CAAC,uBAAuB,EAAE,CAAC;YACnC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACtB,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,WAAW,UAAU,wDAAwD,CAAC,CAAC;YAClI,CAAC,CAAC;YAEF,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAE,cAAsB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC;QACzG,CAAC;QAED,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,+BAA+B;QACnF,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,SAAc,EAAE,MAAqB;QAChE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,CAAC,CAAC,mCAAmC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,SAAS,YAAY,MAAM;gBACvC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,aAAqB,EAAE,MAAgB;QAClE,4DAA4D;QAC5D,MAAM,QAAQ,GAA+B,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;YAC1D,MAAM,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjD,mDAAmD;QACnD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,aAAqB;QACrD,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAgB;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACxC,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACxG,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB,IAAI,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAEzH;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAqB;QACvD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACrD,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM;gBAC5B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;;AAGH;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,gBAAgB;IAC3B,4DAA4D;IACpD,SAAS,GAAG,IAAI,GAAG,EAA0B,CAAC;IAC9C,cAAc,GAAG,IAAI,GAAG,EAAsB,CAAC;IAEvD,wCAAwC;IACxC,4DAA4D;IACrD,IAAI,CAAC,aAAqB;QAC/B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,4DAA4D;IACrD,aAAa,CAAC,OAAmB;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC9C,OAAO,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1D,CAAC;IAED,gCAAgC;IAChC,4DAA4D;IACrD,GAAG,CAAC,aAAqB,EAAE,QAAwB;QACxD,MAAM,IAAI,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACzC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACnC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAClD,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 { DbResult, Id64, Id64String, IModelStatus, Logger } from \"@itwin/core-bentley\";\nimport { EntityMetaData, EntityReferenceSet, IModelError, RelatedElement } from \"@itwin/core-common\";\nimport { Entity } from \"./Entity\";\nimport { IModelDb } from \"./IModelDb\";\nimport { Schema, Schemas } from \"./Schema\";\nimport { EntityReferences } from \"./EntityReferences\";\nimport * as assert from \"assert\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\nconst isGeneratedClassTag = Symbol(\"isGeneratedClassTag\");\n\n/** Maintains the mapping between the name of a BIS [ECClass]($ecschema-metadata) (in \"schema:class\" format) and the JavaScript [[Entity]] class that implements it.\n * @public\n */\nexport class EntityJsClassMap {\n  private readonly _classMap = new Map<string, typeof Entity>();\n\n  /** @internal */\n  public has(classFullName: string): boolean {\n    return this._classMap.has(classFullName.toLowerCase());\n  }\n\n  /** @internal */\n  public get(classFullName: string): typeof Entity | undefined {\n    return this._classMap.get(classFullName.toLowerCase());\n  }\n\n  /** @internal */\n  public set(classFullName: string, entityClass: typeof Entity): void {\n    this._classMap.set(classFullName.toLowerCase(), entityClass);\n  }\n\n  /** @internal */\n  public delete(classFullName: string): boolean {\n    return this._classMap.delete(classFullName.toLowerCase());\n  }\n\n  /** @internal */\n  public clear(): void {\n    this._classMap.clear();\n  }\n\n  /** @internal */\n  public [Symbol.iterator](): IterableIterator<[string, typeof Entity]> {\n    return this._classMap[Symbol.iterator]();\n  }\n\n  /**\n   * Registers a single `entityClass` defined in the specified `schema`.\n   * This method registers the class globally. To register a class for a specific iModel, use [[IModelDb.jsClassMap]].\n   *\n   * @param entityClass - The JavaScript class that implements the BIS [ECClass](@itwin/core-common) to be registered.\n   * @param schema - The schema that contains the `entityClass`.\n   *\n   * @throws Error if the class is already registered.\n   *\n   * @public\n   */\n  public register(entityClass: typeof Entity, schema: typeof Schema): void {\n    const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();\n    if (this.has(key)) {\n      const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;\n      Logger.logError(\"core-frontend.classRegistry\", errMsg);\n      throw new Error(errMsg);\n    }\n    entityClass.schema = schema;\n    this.set(key, entityClass);\n  }\n}\n\n/** Maintains the mapping between the name of a BIS [ECClass]($ecschema-metadata) (in \"schema:class\" format) and the JavaScript [[Entity]] class that implements it.\n * Applications or modules that supply their own Entity subclasses should use [[registerModule]] or [[register]] at startup\n * to establish their mappings.\n * @public\n */\nexport class ClassRegistry {\n  private static readonly _globalClassMap = new EntityJsClassMap();\n  /** @internal */\n  public static isNotFoundError(err: any) { return (err instanceof IModelError) && (err.errorNumber === IModelStatus.NotFound); }\n  /** @internal */\n  public static makeMetaDataNotFoundError(className: string): IModelError { return new IModelError(IModelStatus.NotFound, `metadata not found for ${className}`); }\n  /** Register a single `entityClass` defined in the specified `schema`.\n   * @see [[registerModule]] to register multiple classes.\n   * @public\n   */\n  public static register(entityClass: typeof Entity, schema: typeof Schema) {\n    this._globalClassMap.register(entityClass, schema);\n  }\n\n  /** Generate a proxy Schema for a domain that has not been registered. */\n  private static generateProxySchema(domain: string, iModel: IModelDb): typeof Schema {\n    const hasBehavior = iModel.withPreparedSqliteStatement(`\n      SELECT NULL FROM [ec_CustomAttribute] [c]\n        JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]\n        JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]\n        JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]\n      WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {\n      stmt.bindString(1, domain);\n      stmt.bindString(2, \"BisCore.SchemaHasBehavior\");\n      return stmt.step() === DbResult.BE_SQLITE_ROW;\n    });\n\n    const schemaClass = class extends Schema {\n      public static override get schemaName() { return domain; }\n      public static override get missingRequiredBehavior() { return hasBehavior; }\n    };\n\n    iModel.schemaMap.registerSchema(schemaClass); // register the class before we return it.\n    return schemaClass;\n  }\n\n  /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).\n   * Then, gets its metadata and returns that.\n   * @param iModel - iModel containing the metadata for this type\n   * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of\n   * @returns the qualified full name of an ECEntityClass\n   * @internal public for testing only\n   */\n  public static getRootEntity(iModel: IModelDb, ecTypeQualifier: string): string {\n    const [classSchema, className] = ecTypeQualifier.split(\".\");\n    const schemaItemJson = iModel[_nativeDb].getSchemaItem(classSchema, className);\n    if (schemaItemJson.error)\n      throw new IModelError(schemaItemJson.error.status, `failed to get schema item '${ecTypeQualifier}'`);\n\n    assert(undefined !== schemaItemJson.result);\n    const schemaItem = JSON.parse(schemaItemJson.result);\n    if (!(\"appliesTo\" in schemaItem) && schemaItem.baseClass === undefined) {\n      return ecTypeQualifier;\n    }\n\n    // typescript doesn't understand that the inverse of the above condition is\n    // (\"appliesTo\" in rootclassMetaData || rootClassMetaData.baseClass !== undefined)\n    const parentItemQualifier = schemaItem.appliesTo ?? schemaItem.baseClass as string;\n    return this.getRootEntity(iModel, parentItemQualifier);\n  }\n\n  /** Generate a JavaScript class from Entity metadata.\n   * @param entityMetaData The Entity metadata that defines the class\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  private static generateClassForEntity(entityMetaData: EntityMetaData, iModel: IModelDb): typeof Entity {\n    const name = entityMetaData.ecclass.split(\":\");\n    const domainName = name[0];\n    const className = name[1];\n\n    if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass\n      throw new IModelError(IModelStatus.BadArg, `class ${name} has no superclass`);\n\n    // make sure schema exists\n    let schema = iModel.schemaMap.get(domainName) ?? Schemas.getRegisteredSchema(domainName);\n    if (undefined === schema)\n      schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too\n\n    const superClassFullName = entityMetaData.baseClasses[0].toLowerCase();\n    const superclass = iModel.jsClassMap.get(superClassFullName) ?? this._globalClassMap.get(superClassFullName);\n    if (undefined === superclass)\n      throw new IModelError(IModelStatus.NotFound, `cannot find superclass for class ${name}`);\n\n    // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot\n    // be used to tell if there are any generated classes in the hierarchy\n    let generatedClassHasNonGeneratedNonCoreAncestor = false;\n    let currentSuperclass = superclass;\n    const MAX_ITERS = 1000;\n    for (let i = 0; i < MAX_ITERS; ++i) {\n      if (currentSuperclass.schema.schemaName === \"BisCore\")\n        break;\n\n      if (!currentSuperclass.isGeneratedClass) {\n        generatedClassHasNonGeneratedNonCoreAncestor = true;\n        break;\n      }\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);\n      if (superclassMetaData === undefined)\n        throw new IModelError(IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);\n      const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);\n      if (maybeNextSuperclass === undefined)\n        throw new IModelError(IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);\n      currentSuperclass = maybeNextSuperclass;\n    }\n\n    const generatedClass = class extends superclass {\n      public static override get className() { return className; }\n      private static [isGeneratedClassTag] = true;\n      public static override get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }\n    };\n\n    // the above creates an anonymous class. For help debugging, set the \"constructor.name\" property to be the same as the bisClassName.\n    Object.defineProperty(generatedClass, \"name\", { get: () => className });  // this is the (only) way to change that readonly property.\n\n    // a class only gets an automatic `collectReferenceIds` implementation if:\n    // - it is not in the `BisCore` schema\n    // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)\n    if (!generatedClassHasNonGeneratedNonCoreAncestor) {\n      const navigationProps = Object.entries(entityMetaData.properties)\n        .filter(([_name, prop]) => prop.isNavigation)\n        // eslint-disable-next-line @typescript-eslint/no-shadow\n        .map(([name, prop]) => {\n          assert(prop.relationshipClass);\n          const maybeMetaData = iModel[_nativeDb].getSchemaItem(...prop.relationshipClass.split(\":\") as [string, string]);\n          assert(maybeMetaData.result !== undefined, \"The nav props relationship metadata was not found\");\n          const relMetaData = JSON.parse(maybeMetaData.result);\n          const rootClassMetaData = ClassRegistry.getRootEntity(iModel, relMetaData.target.constraintClasses[0]);\n          // root class must be in BisCore so should be loaded since biscore classes will never get this\n          // generated implementation\n          const normalizeClassName = (clsName: string) => clsName.replace(\".\", \":\");\n          const rootClass = ClassRegistry.findRegisteredClass(normalizeClassName(rootClassMetaData));\n          assert(rootClass, `The root class for ${prop.relationshipClass} was not in BisCore.`);\n          return { name, concreteEntityType: EntityReferences.typeFromClass(rootClass) };\n        });\n\n      Object.defineProperty(\n        generatedClass.prototype,\n        \"collectReferenceIds\",\n        {\n          value(this: typeof generatedClass, referenceIds: EntityReferenceSet) {\n            // eslint-disable-next-line @typescript-eslint/dot-notation\n            const superImpl = superclass.prototype[\"collectReferenceIds\"];\n            superImpl.call(this, referenceIds);\n            for (const navProp of navigationProps) {\n              const relatedElem: RelatedElement | undefined = (this as any)[navProp.name]; // cast to any since subclass can have any extensions\n              if (!relatedElem || !Id64.isValid(relatedElem.id))\n                continue;\n              const referenceId = EntityReferences.fromEntityType(relatedElem.id, navProp.concreteEntityType);\n              referenceIds.add(referenceId);\n            }\n          },\n          // defaults for methods on a prototype (required for sinon to stub out methods on tests)\n          writable: true,\n          configurable: true,\n        },\n      );\n    }\n\n    // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations\n    if (schema.missingRequiredBehavior) {\n      const throwError = () => {\n        throw new IModelError(IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`);\n      };\n\n      superclass.protectedOperations.forEach((operation) => (generatedClass as any)[operation] = throwError);\n    }\n\n    iModel.jsClassMap.register(generatedClass, schema); // register it before returning\n    return generatedClass;\n  }\n\n  /** Register all of the classes found in the given module that derive from [[Entity]].\n   * [[register]] will be invoked for each subclass of `Entity` exported by `moduleObj`.\n   * @param moduleObj The module to search for subclasses of Entity\n   * @param schema The schema that contains all of the [ECClass]($ecschema-metadata)es exported by `moduleObj`.\n   */\n  public static registerModule(moduleObj: any, schema: typeof Schema) {\n    for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in\n      const thisClass = moduleObj[thisMember];\n      if (thisClass.prototype instanceof Entity)\n        this.register(thisClass, schema);\n    }\n  }\n\n  /**\n   * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated\n   * class. This function also ensures that all of the base classes of the Entity exist and are registered.\n   */\n  private static generateClass(classFullName: string, iModel: IModelDb): typeof Entity {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    const metadata: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(classFullName);\n    if (metadata === undefined || metadata.ecclass === undefined)\n      throw this.makeMetaDataNotFoundError(classFullName);\n\n    // Make sure we have all base classes registered.\n    if (metadata.baseClasses && (0 !== metadata.baseClasses.length))\n      this.getClass(metadata.baseClasses[0], iModel);\n\n    // Now we can generate the class from the classDef.\n    return this.generateClassForEntity(metadata, iModel);\n  }\n\n  /** Find a registered class by classFullName.\n   * @param classFullName class to find\n   * @param iModel The IModel that contains the class definitions\n   * @returns The Entity class or undefined\n   */\n  public static findRegisteredClass(classFullName: string): typeof Entity | undefined {\n    return this._globalClassMap.get(classFullName.toLowerCase());\n  }\n\n  /** Get the Entity class for the specified Entity className.\n   * @param classFullName The full BIS class name of the Entity\n   * @param iModel The IModel that contains the class definitions\n   * @returns The Entity class\n   */\n  public static getClass(classFullName: string, iModel: IModelDb): typeof Entity {\n    const key = classFullName.toLowerCase();\n    return iModel.jsClassMap.get(key) ?? this._globalClassMap.get(key) ?? this.generateClass(key, iModel);\n  }\n\n  /** Unregister a class, by name, if one is already registered.\n   * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.\n   * @param classFullName Name of the class to unregister\n   * @return true if the class was unregistered\n   * @internal\n   */\n  public static unregisterClass(classFullName: string) { return this._globalClassMap.delete(classFullName.toLowerCase()); }\n\n  /** Unregister all classes from a schema.\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\n   * @param schema Name of the schema to unregister\n   * @internal\n   */\n  public static unregisterClassesFrom(schema: typeof Schema) {\n    for (const entry of Array.from(this._globalClassMap)) {\n      if (entry[1].schema === schema)\n        this.unregisterClass(entry[0]);\n    }\n  }\n}\n\n/**\n * A cache that records the mapping between class names and class metadata.\n * @see [[IModelDb.classMetaDataRegistry]] to access the registry for a specific iModel.\n * @internal\n * @deprecated in 5.0. Please use `schemaContext` from the `iModel` instead.\n *\n * @example\n * @\n * Current Usage:\n * ```ts\n * const metaData: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(\"SchemaName:ClassName\");\n * ```\n *\n * Replacement:\n * ```ts\n * const entityMetaData: EntityClass | undefined = iModel.schemaContext.getSchemaItemSync(\"SchemaName.ClassName\", EntityClass);\n * const relationshipMetaData: RelationshipClass | undefined = iModel.schemaContext.getSchemaItemSync(\"SchemaName\", \"ClassName\", RelationshipClass);\n * ```\n */\nexport class MetaDataRegistry {\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  private _registry = new Map<string, EntityMetaData>();\n  private _classIdToName = new Map<Id64String, string>();\n\n  /** Get the specified Entity metadata */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public find(classFullName: string): EntityMetaData | undefined {\n    return this._registry.get(classFullName.toLowerCase());\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public findByClassId(classId: Id64String): EntityMetaData | undefined {\n    const name = this._classIdToName.get(classId);\n    return undefined !== name ? this.find(name) : undefined;\n  }\n\n  /** Add metadata to the cache */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public add(classFullName: string, metaData: EntityMetaData): void {\n    const name = classFullName.toLowerCase();\n    this._registry.set(name, metaData);\n    this._classIdToName.set(metaData.classId, name);\n  }\n}\n"]}
+{"version":3,"file":"ClassRegistry.js","sourceRoot":"","sources":["../../src/ClassRegistry.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAc,YAAY,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACvF,OAAO,EAAsC,WAAW,EAAkB,MAAM,oBAAoB,CAAC;AACrG,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,MAAM,mBAAmB,GAAG,MAAM,CAAC,qBAAqB,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,gBAAgB;IACV,SAAS,GAAG,IAAI,GAAG,EAAyB,CAAC;IAE9D,gBAAgB;IACT,GAAG,CAAC,aAAqB;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,aAAqB;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,aAAqB,EAAE,WAA0B;QAC1D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,WAAW,CAAC,CAAC;IAC/D,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,aAAqB;QACjC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,gBAAgB;IACT,KAAK;QACV,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;IAED,gBAAgB;IACT,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;OAUG;IACI,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QAC/D,MAAM,GAAG,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,MAAM,GAAG,SAAS,GAAG,4FAA4F,WAAW,CAAC,IAAI,EAAE,CAAC;YAC1I,MAAM,CAAC,QAAQ,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;QAC1B,CAAC;QACD,WAAW,CAAC,MAAM,GAAG,MAAM,CAAC;QAC5B,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IAC7B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,aAAa;IAChB,MAAM,CAAU,eAAe,GAAG,IAAI,gBAAgB,EAAE,CAAC;IACjE,gBAAgB;IACT,MAAM,CAAC,eAAe,CAAC,GAAQ,IAAI,OAAO,CAAC,GAAG,YAAY,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC/H,gBAAgB;IACT,MAAM,CAAC,yBAAyB,CAAC,SAAiB,IAAiB,OAAO,IAAI,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,0BAA0B,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACjK;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,WAA0B,EAAE,MAAqB;QACtE,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,mBAAmB,CAAC,MAAc,EAAE,MAAgB;QACjE,MAAM,WAAW,GAAG,MAAM,CAAC,2BAA2B,CAAC;;;;;+FAKoC,EAAE,CAAC,IAAI,EAAE,EAAE;YACpG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,2BAA2B,CAAC,CAAC;YAChD,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,QAAQ,CAAC,aAAa,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,KAAM,SAAQ,MAAM;YAC/B,MAAM,KAAc,UAAU,KAAK,OAAO,MAAM,CAAC,CAAC,CAAC;YACnD,MAAM,KAAc,uBAAuB,KAAK,OAAO,WAAW,CAAC,CAAC,CAAC;SAC7E,CAAC;QAEF,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,0CAA0C;QACxF,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,MAAgB,EAAE,eAAuB;QACnE,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5D,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QAC/E,IAAI,cAAc,CAAC,KAAK;YACtB,MAAM,IAAI,WAAW,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,EAAE,8BAA8B,eAAe,GAAG,CAAC,CAAC;QAEvG,MAAM,CAAC,SAAS,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACrD,IAAI,CAAC,CAAC,WAAW,IAAI,UAAU,CAAC,IAAI,UAAU,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACvE,OAAO,eAAe,CAAC;QACzB,CAAC;QAED,2EAA2E;QAC3E,kFAAkF;QAClF,MAAM,mBAAmB,GAAG,UAAU,CAAC,SAAS,IAAI,UAAU,CAAC,SAAmB,CAAC;QACnF,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,4DAA4D;IACpD,MAAM,CAAC,sBAAsB,CAAC,cAA8B,EAAE,MAAgB;QACpF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAE1B,IAAI,CAAC,KAAK,cAAc,CAAC,WAAW,CAAC,MAAM,EAAE,qCAAqC;YAChF,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAoB,CAAC,CAAC;QAEhF,0BAA0B;QAC1B,IAAI,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QACzF,IAAI,SAAS,KAAK,MAAM;YACtB,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,iCAAiC;QAE1F,MAAM,kBAAkB,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;QACvE,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;QAC7G,IAAI,SAAS,KAAK,UAAU;YAC1B,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,QAAQ,EAAE,oCAAoC,IAAI,EAAE,CAAC,CAAC;QAE3F,6GAA6G;QAC7G,sEAAsE;QACtE,IAAI,4CAA4C,GAAG,KAAK,CAAC;QACzD,IAAI,iBAAiB,GAAG,UAAU,CAAC;QACnC,MAAM,SAAS,GAAG,IAAI,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,EAAE,CAAC,EAAE,CAAC;YACnC,IAAI,iBAAiB,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS;gBACnD,MAAM;YAER,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,CAAC;gBACxC,4CAA4C,GAAG,IAAI,CAAC;gBACpD,MAAM;YACR,CAAC;YACD,4DAA4D;YAC5D,MAAM,kBAAkB,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;YAC9F,IAAI,kBAAkB,KAAK,SAAS;gBAClC,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,0CAA0C,iBAAiB,CAAC,IAAI,2CAA2C,CAAC,CAAC;YAC7J,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;YACrF,IAAI,mBAAmB,KAAK,SAAS;gBACnC,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,SAAS,EAAE,qCAAqC,iBAAiB,CAAC,IAAI,iDAAiD,CAAC,CAAC;YAC9J,iBAAiB,GAAG,mBAAmB,CAAC;QAC1C,CAAC;QAED,MAAM,cAAc,GAAG,KAAM,SAAQ,UAAU;YACtC,MAAM,KAAc,SAAS,KAAK,OAAO,SAAS,CAAC,CAAC,CAAC;YACpD,MAAM,CAAC,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC;YACrC,MAAM,KAAc,gBAAgB,KAAK,OAAO,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;SACnG,CAAC;QAEF,oIAAoI;QACpI,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC,CAAE,2DAA2D;QAErI,0EAA0E;QAC1E,sCAAsC;QACtC,yGAAyG;QACzG,IAAI,CAAC,4CAA4C,EAAE,CAAC;YAClD,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC;iBAC9D,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;gBAC7C,wDAAwD;iBACvD,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;gBACpB,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAC/B,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAqB,CAAC,CAAC;gBAChH,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,SAAS,EAAE,mDAAmD,CAAC,CAAC;gBAChG,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;gBACrD,MAAM,iBAAiB,GAAG,aAAa,CAAC,aAAa,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvG,8FAA8F;gBAC9F,2BAA2B;gBAC3B,MAAM,kBAAkB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAC1E,MAAM,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC,CAAC;gBAC3F,MAAM,CAAC,SAAS,EAAE,sBAAsB,IAAI,CAAC,iBAAiB,sBAAsB,CAAC,CAAC;gBACtF,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,gBAAgB,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;YACjF,CAAC,CAAC,CAAC;YAEL,MAAM,CAAC,cAAc,CACnB,cAAc,CAAC,SAAS,EACxB,qBAAqB,EACrB;gBACE,KAAK,CAA8B,YAAgC;oBACjE,2DAA2D;oBAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;oBAC9D,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;oBACnC,KAAK,MAAM,OAAO,IAAI,eAAe,EAAE,CAAC;wBACtC,MAAM,WAAW,GAAgC,IAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,qDAAqD;wBAClI,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BAC/C,SAAS;wBACX,MAAM,WAAW,GAAG,gBAAgB,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;wBAChG,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;oBAChC,CAAC;gBACH,CAAC;gBACD,wFAAwF;gBACxF,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,IAAI;aACnB,CACF,CAAC;QACJ,CAAC;QAED,qGAAqG;QACrG,IAAI,MAAM,CAAC,uBAAuB,EAAE,CAAC;YACnC,MAAM,UAAU,GAAG,GAAG,EAAE;gBACtB,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,YAAY,EAAE,WAAW,UAAU,wDAAwD,CAAC,CAAC;YAClI,CAAC,CAAC;YAEF,UAAU,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAAE,cAAsB,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,CAAC;QACzG,CAAC;QAED,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,+BAA+B;QACnF,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,SAAc,EAAE,MAAqB;QAChE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,CAAC,CAAC,mCAAmC;YACvE,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,SAAS,YAAY,MAAM;gBACvC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,aAAa,CAAC,aAAqB,EAAE,MAAgB;QAClE,4DAA4D;QAC5D,MAAM,QAAQ,GAA+B,MAAM,CAAC,qBAAqB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC9F,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS;YAC1D,MAAM,IAAI,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;QAEtD,iDAAiD;QACjD,IAAI,QAAQ,CAAC,WAAW,IAAI,CAAC,CAAC,KAAK,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAEjD,mDAAmD;QACnD,OAAO,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB,CAAC,aAAqB;QACrD,OAAO,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,aAAqB,EAAE,MAAgB;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACxC,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACxG,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,aAAqB,IAAI,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAEzH;;;;OAIG;IACI,MAAM,CAAC,qBAAqB,CAAC,MAAqB;QACvD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACrD,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM;gBAC5B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;;AAGH;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,gBAAgB;IAC3B,4DAA4D;IACpD,SAAS,GAAG,IAAI,GAAG,EAA0B,CAAC;IAC9C,cAAc,GAAG,IAAI,GAAG,EAAsB,CAAC;IAEvD,wCAAwC;IACxC,4DAA4D;IACrD,IAAI,CAAC,aAAqB;QAC/B,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,4DAA4D;IACrD,aAAa,CAAC,OAAmB;QACtC,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC9C,OAAO,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1D,CAAC;IAED,gCAAgC;IAChC,4DAA4D;IACrD,GAAG,CAAC,aAAqB,EAAE,QAAwB;QACxD,MAAM,IAAI,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC;QACzC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACnC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAClD,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 { DbResult, Id64, Id64String, IModelStatus, Logger } from \"@itwin/core-bentley\";\nimport { EntityMetaData, EntityReferenceSet, IModelError, RelatedElement } from \"@itwin/core-common\";\nimport { Entity } from \"./Entity\";\nimport { IModelDb } from \"./IModelDb\";\nimport { Schema, Schemas } from \"./Schema\";\nimport { EntityReferences } from \"./EntityReferences\";\nimport * as assert from \"assert\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\nconst isGeneratedClassTag = Symbol(\"isGeneratedClassTag\");\n\n/** Maintains the mapping between the name of a BIS [ECClass]($ecschema-metadata) (in \"schema:class\" format) and the JavaScript [[Entity]] class that implements it.\n * @public\n */\nexport class EntityJsClassMap {\n  private readonly _classMap = new Map<string, typeof Entity>();\n\n  /** @internal */\n  public has(classFullName: string): boolean {\n    return this._classMap.has(classFullName.toLowerCase());\n  }\n\n  /** @internal */\n  public get(classFullName: string): typeof Entity | undefined {\n    return this._classMap.get(classFullName.toLowerCase());\n  }\n\n  /** @internal */\n  public set(classFullName: string, entityClass: typeof Entity): void {\n    this._classMap.set(classFullName.toLowerCase(), entityClass);\n  }\n\n  /** @internal */\n  public delete(classFullName: string): boolean {\n    return this._classMap.delete(classFullName.toLowerCase());\n  }\n\n  /** @internal */\n  public clear(): void {\n    this._classMap.clear();\n  }\n\n  /** @internal */\n  public [Symbol.iterator](): IterableIterator<[string, typeof Entity]> {\n    return this._classMap[Symbol.iterator]();\n  }\n\n  /**\n   * Registers a single `entityClass` defined in the specified `schema`.\n   * This method registers the class globally. To register a class for a specific iModel, use [[IModelDb.jsClassMap]].\n   *\n   * @param entityClass - The JavaScript class that implements the BIS [ECClass](@itwin/core-common) to be registered.\n   * @param schema - The schema that contains the `entityClass`.\n   *\n   * @throws Error if the class is already registered.\n   *\n   * @public\n   */\n  public register(entityClass: typeof Entity, schema: typeof Schema): void {\n    const key = (`${schema.schemaName}:${entityClass.className}`).toLowerCase();\n    if (this.has(key)) {\n      const errMsg = `Class ${key} is already registered. Make sure static className member is correct on JavaScript class ${entityClass.name}`;\n      Logger.logError(\"core-frontend.classRegistry\", errMsg);\n      throw new Error(errMsg);\n    }\n    entityClass.schema = schema;\n    this.set(key, entityClass);\n  }\n}\n\n/** Maintains the mapping between the name of a BIS [ECClass]($ecschema-metadata) (in \"schema:class\" format) and the JavaScript [[Entity]] class that implements it.\n * Applications or modules that supply their own Entity subclasses should use [[registerModule]] or [[register]] at startup\n * to establish their mappings.\n * @public\n */\nexport class ClassRegistry {\n  private static readonly _globalClassMap = new EntityJsClassMap();\n  /** @internal */\n  public static isNotFoundError(err: any) { return (err instanceof IModelError) && (err.errorNumber === IModelStatus.NotFound); }\n  /** @internal */\n  public static makeMetaDataNotFoundError(className: string): IModelError { return new IModelError(IModelStatus.NotFound, `metadata not found for ${className}`); }\n  /** Register a single `entityClass` defined in the specified `schema`.\n   * @see [[registerModule]] to register multiple classes.\n   * @public\n   */\n  public static register(entityClass: typeof Entity, schema: typeof Schema) {\n    this._globalClassMap.register(entityClass, schema);\n  }\n\n  /** Generate a proxy Schema for a domain that has not been registered. */\n  private static generateProxySchema(domain: string, iModel: IModelDb): typeof Schema {\n    const hasBehavior = iModel.withPreparedSqliteStatement(`\n      SELECT NULL FROM [ec_CustomAttribute] [c]\n        JOIN [ec_schema] [s] ON [s].[Id] = [c].[ContainerId]\n        JOIN [ec_class] [e] ON [e].[Id] = [c].[ClassId]\n        JOIN [ec_schema] [b] ON [e].[SchemaId] = [b].[Id]\n      WHERE [c].[ContainerType] = 1 AND [s].[Name] = ? AND [b].[Name] || '.' || [e].[name] = ?`, (stmt) => {\n      stmt.bindString(1, domain);\n      stmt.bindString(2, \"BisCore.SchemaHasBehavior\");\n      return stmt.step() === DbResult.BE_SQLITE_ROW;\n    });\n\n    const schemaClass = class extends Schema {\n      public static override get schemaName() { return domain; }\n      public static override get missingRequiredBehavior() { return hasBehavior; }\n    };\n\n    iModel.schemaMap.registerSchema(schemaClass); // register the class before we return it.\n    return schemaClass;\n  }\n\n  /** First, finds the root BisCore entity class for an entity, by traversing base classes and mixin targets (AppliesTo).\n   * Then, gets its metadata and returns that.\n   * @param iModel - iModel containing the metadata for this type\n   * @param ecTypeQualifier - a full name of an ECEntityClass to find the root of\n   * @returns the qualified full name of an ECEntityClass\n   * @internal public for testing only\n   */\n  public static getRootEntity(iModel: IModelDb, ecTypeQualifier: string): string {\n    const [classSchema, className] = ecTypeQualifier.split(\".\");\n    const schemaItemJson = iModel[_nativeDb].getSchemaItem(classSchema, className);\n    if (schemaItemJson.error)\n      throw new IModelError(schemaItemJson.error.status, `failed to get schema item '${ecTypeQualifier}'`);\n\n    assert(undefined !== schemaItemJson.result);\n    const schemaItem = JSON.parse(schemaItemJson.result);\n    if (!(\"appliesTo\" in schemaItem) && schemaItem.baseClass === undefined) {\n      return ecTypeQualifier;\n    }\n\n    // typescript doesn't understand that the inverse of the above condition is\n    // (\"appliesTo\" in rootclassMetaData || rootClassMetaData.baseClass !== undefined)\n    const parentItemQualifier = schemaItem.appliesTo ?? schemaItem.baseClass as string;\n    return this.getRootEntity(iModel, parentItemQualifier);\n  }\n\n  /** Generate a JavaScript class from Entity metadata.\n   * @param entityMetaData The Entity metadata that defines the class\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  private static generateClassForEntity(entityMetaData: EntityMetaData, iModel: IModelDb): typeof Entity {\n    const name = entityMetaData.ecclass.split(\":\");\n    const domainName = name[0];\n    const className = name[1];\n\n    if (0 === entityMetaData.baseClasses.length) // metadata must contain a superclass\n      throw new IModelError(IModelStatus.BadArg, `class ${name} has no superclass`);\n\n    // make sure schema exists\n    let schema = iModel.schemaMap.get(domainName) ?? Schemas.getRegisteredSchema(domainName);\n    if (undefined === schema)\n      schema = this.generateProxySchema(domainName, iModel); // no schema found, create it too\n\n    const superClassFullName = entityMetaData.baseClasses[0].toLowerCase();\n    const superclass = iModel.jsClassMap.get(superClassFullName) ?? this._globalClassMap.get(superClassFullName);\n    if (undefined === superclass)\n      throw new IModelError(IModelStatus.NotFound, `cannot find superclass for class ${name}`);\n\n    // user defined class hierarchies may skip a class in the hierarchy, and therefore their JS base class cannot\n    // be used to tell if there are any generated classes in the hierarchy\n    let generatedClassHasNonGeneratedNonCoreAncestor = false;\n    let currentSuperclass = superclass;\n    const MAX_ITERS = 1000;\n    for (let i = 0; i < MAX_ITERS; ++i) {\n      if (currentSuperclass.schema.schemaName === \"BisCore\")\n        break;\n\n      if (!currentSuperclass.isGeneratedClass) {\n        generatedClassHasNonGeneratedNonCoreAncestor = true;\n        break;\n      }\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      const superclassMetaData = iModel.classMetaDataRegistry.find(currentSuperclass.classFullName);\n      if (superclassMetaData === undefined)\n        throw new IModelError(IModelStatus.BadSchema, `could not find the metadata for class '${currentSuperclass.name}', class metadata should be loaded by now`);\n      const maybeNextSuperclass = this.getClass(superclassMetaData.baseClasses[0], iModel);\n      if (maybeNextSuperclass === undefined)\n        throw new IModelError(IModelStatus.BadSchema, `could not find the base class of '${currentSuperclass.name}', all generated classes must have a base class`);\n      currentSuperclass = maybeNextSuperclass;\n    }\n\n    const generatedClass = class extends superclass {\n      public static override get className() { return className; }\n      private static [isGeneratedClassTag] = true;\n      public static override get isGeneratedClass() { return this.hasOwnProperty(isGeneratedClassTag); }\n    };\n\n    // the above creates an anonymous class. For help debugging, set the \"constructor.name\" property to be the same as the bisClassName.\n    Object.defineProperty(generatedClass, \"name\", { get: () => className });  // this is the (only) way to change that readonly property.\n\n    // a class only gets an automatic `collectReferenceIds` implementation if:\n    // - it is not in the `BisCore` schema\n    // - there are no ancestors with manually registered JS implementations, (excluding BisCore base classes)\n    if (!generatedClassHasNonGeneratedNonCoreAncestor) {\n      const navigationProps = Object.entries(entityMetaData.properties)\n        .filter(([_name, prop]) => prop.isNavigation)\n        // eslint-disable-next-line @typescript-eslint/no-shadow\n        .map(([name, prop]) => {\n          assert(prop.relationshipClass);\n          const maybeMetaData = iModel[_nativeDb].getSchemaItem(...prop.relationshipClass.split(\":\") as [string, string]);\n          assert(maybeMetaData.result !== undefined, \"The nav props relationship metadata was not found\");\n          const relMetaData = JSON.parse(maybeMetaData.result);\n          const rootClassMetaData = ClassRegistry.getRootEntity(iModel, relMetaData.target.constraintClasses[0]);\n          // root class must be in BisCore so should be loaded since biscore classes will never get this\n          // generated implementation\n          const normalizeClassName = (clsName: string) => clsName.replace(\".\", \":\");\n          const rootClass = ClassRegistry.findRegisteredClass(normalizeClassName(rootClassMetaData));\n          assert(rootClass, `The root class for ${prop.relationshipClass} was not in BisCore.`);\n          return { name, concreteEntityType: EntityReferences.typeFromClass(rootClass) };\n        });\n\n      Object.defineProperty(\n        generatedClass.prototype,\n        \"collectReferenceIds\",\n        {\n          value(this: typeof generatedClass, referenceIds: EntityReferenceSet) {\n            // eslint-disable-next-line @typescript-eslint/dot-notation\n            const superImpl = superclass.prototype[\"collectReferenceIds\"];\n            superImpl.call(this, referenceIds);\n            for (const navProp of navigationProps) {\n              const relatedElem: RelatedElement | undefined = (this as any)[navProp.name]; // cast to any since subclass can have any extensions\n              if (!relatedElem || !Id64.isValid(relatedElem.id))\n                continue;\n              const referenceId = EntityReferences.fromEntityType(relatedElem.id, navProp.concreteEntityType);\n              referenceIds.add(referenceId);\n            }\n          },\n          // defaults for methods on a prototype (required for sinon to stub out methods on tests)\n          writable: true,\n          configurable: true,\n        },\n      );\n    }\n\n    // if the schema is a proxy for a domain with behavior, throw exceptions for all protected operations\n    if (schema.missingRequiredBehavior) {\n      const throwError = () => {\n        throw new IModelError(IModelStatus.WrongHandler, `Schema [${domainName}] not registered, but is marked with SchemaHasBehavior`);\n      };\n\n      superclass.protectedOperations.forEach((operation) => (generatedClass as any)[operation] = throwError);\n    }\n\n    iModel.jsClassMap.register(generatedClass, schema); // register it before returning\n    return generatedClass;\n  }\n\n  /** Register all of the classes found in the given module that derive from [[Entity]].\n   * [[register]] will be invoked for each subclass of `Entity` exported by `moduleObj`.\n   * @param moduleObj The module to search for subclasses of Entity\n   * @param schema The schema that contains all of the [ECClass]($ecschema-metadata)es exported by `moduleObj`.\n   */\n  public static registerModule(moduleObj: any, schema: typeof Schema) {\n    for (const thisMember in moduleObj) { // eslint-disable-line guard-for-in\n      const thisClass = moduleObj[thisMember];\n      if (thisClass.prototype instanceof Entity)\n        this.register(thisClass, schema);\n    }\n  }\n\n  /**\n   * This function fetches the specified Entity from the imodel, generates a JavaScript class for it, and registers the generated\n   * class. This function also ensures that all of the base classes of the Entity exist and are registered.\n   */\n  private static generateClass(classFullName: string, iModel: IModelDb): typeof Entity {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    const metadata: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(classFullName);\n    if (metadata === undefined || metadata.ecclass === undefined)\n      throw this.makeMetaDataNotFoundError(classFullName);\n\n    // Make sure we have all base classes registered.\n    if (metadata.baseClasses && (0 !== metadata.baseClasses.length))\n      this.getClass(metadata.baseClasses[0], iModel);\n\n    // Now we can generate the class from the classDef.\n    return this.generateClassForEntity(metadata, iModel);\n  }\n\n  /** Find a registered class by classFullName.\n   * @param classFullName class to find\n   * @param iModel The IModel that contains the class definitions\n   * @returns The Entity class or undefined\n   */\n  public static findRegisteredClass(classFullName: string): typeof Entity | undefined {\n    return this._globalClassMap.get(classFullName.toLowerCase());\n  }\n\n  /** Get the Entity class for the specified Entity className.\n   * @param classFullName The full BIS class name of the Entity\n   * @param iModel The IModel that contains the class definitions\n   * @returns The Entity class\n   */\n  public static getClass(classFullName: string, iModel: IModelDb): typeof Entity {\n    const key = classFullName.toLowerCase();\n    return iModel.jsClassMap.get(key) ?? this._globalClassMap.get(key) ?? this.generateClass(key, iModel);\n  }\n\n  /** Unregister a class, by name, if one is already registered.\n   * This function is not normally needed, but is useful for cases where a generated *proxy* class needs to be replaced by the *real* class.\n   * @param classFullName Name of the class to unregister\n   * @return true if the class was unregistered\n   * @internal\n   */\n  public static unregisterClass(classFullName: string) { return this._globalClassMap.delete(classFullName.toLowerCase()); }\n\n  /** Unregister all classes from a schema.\n   * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.\n   * @param schema Name of the schema to unregister\n   * @internal\n   */\n  public static unregisterClassesFrom(schema: typeof Schema) {\n    for (const entry of Array.from(this._globalClassMap)) {\n      if (entry[1].schema === schema)\n        this.unregisterClass(entry[0]);\n    }\n  }\n}\n\n/**\n * A cache that records the mapping between class names and class metadata.\n * @see [[IModelDb.classMetaDataRegistry]] to access the registry for a specific iModel.\n * @internal\n * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `schemaContext` from the `iModel` instead.\n *\n * @example\n * @\n * Current Usage:\n * ```ts\n * const metaData: EntityMetaData | undefined = iModel.classMetaDataRegistry.find(\"SchemaName:ClassName\");\n * ```\n *\n * Replacement:\n * ```ts\n * const entityMetaData: EntityClass | undefined = iModel.schemaContext.getSchemaItemSync(\"SchemaName.ClassName\", EntityClass);\n * const relationshipMetaData: RelationshipClass | undefined = iModel.schemaContext.getSchemaItemSync(\"SchemaName\", \"ClassName\", RelationshipClass);\n * ```\n */\nexport class MetaDataRegistry {\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  private _registry = new Map<string, EntityMetaData>();\n  private _classIdToName = new Map<Id64String, string>();\n\n  /** Get the specified Entity metadata */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public find(classFullName: string): EntityMetaData | undefined {\n    return this._registry.get(classFullName.toLowerCase());\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public findByClassId(classId: Id64String): EntityMetaData | undefined {\n    const name = this._classIdToName.get(classId);\n    return undefined !== name ? this.find(name) : undefined;\n  }\n\n  /** Add metadata to the cache */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  public add(classFullName: string, metaData: EntityMetaData): void {\n    const name = classFullName.toLowerCase();\n    this._registry.set(name, metaData);\n    this._classIdToName.set(metaData.classId, name);\n  }\n}\n"]}

package/lib/esm/CodeSpecs.d.ts

@@ -5,7 +5,7 @@ import { Id64String } from "@itwin/core-bentley";
 import { CodeScopeSpec, CodeSpec, CodeSpecProperties } from "@itwin/core-common";
 import { IModelDb } from "./IModelDb";
 /** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]
- * @public
+ * @public @preview
  */
 export declare class CodeSpecs {
     private static tableName;

package/lib/esm/CodeSpecs.js

@@ -8,7 +8,7 @@
 import { BentleyError, DbResult, Id64, IModelStatus } from "@itwin/core-bentley";
 import { CodeSpec, IModelError } from "@itwin/core-common";
 /** Manages [CodeSpecs]($docs/BIS/guide/fundamentals/element-fundamentals.md#codespec) within an [[IModelDb]]
- * @public
+ * @public @preview
  */
 export class CodeSpecs {
     static tableName = "bis_CodeSpec";